Class ChecklistTask

Hierarchy (View Summary)

Base
- ChecklistTask

Index

Constructors

Properties

completedByUser? completionUnixTime? entities? id text

Accessors

client completedAt completionTimestamp isCompleted

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

new ChecklistTask(
client: TelegramClient | BaseClient,
data: ChecklistTask,
): ChecklistTask
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: ChecklistTask
  Data about a task in a checklist.
Returns ChecklistTask
Overrides Base.constructor

Properties

`Optional`completedByUser

completedByUser?: User

User that completed the task; omitted if the task wasn't completed

`Optional`completionUnixTime

completionUnixTime?: number

Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed

`Optional`entities

entities?: MessageEntities

Special entities that appear in the task text

id

id: number

Unique identifier of the task

text

text: string

Text of the task

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

completedAt

get completedAt(): Date | null
Date the task was completed

Returns Date | null

completionTimestamp

get completionTimestamp(): number | null
Return the timestamp task was completed, in milliseconds

Returns number | null

isCompleted

get isCompleted(): boolean
True if the task is completed

Returns boolean

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from Base._clone

`Protected`_patch

_patch(data: Record<string, any>): Record<string, any>
Protected
Patches the current instance with new data
Parameters
- data: Record<string, any>
  The data to patch the instance with
Returns Record<string, any>
The patched data

Inherited from Base._patch

`Protected`_update

_update(data: Record<string, any>): Base
Protected
Updates the current instance with new data and returns a clone of the updated instance
Parameters
- data: Record<string, any>
  The data to update the instance with
Returns Base
A clone of the updated instance

Inherited from Base._update

toJSON

toJSON(
propsRecursive?: boolean,
...props: Record<string, string | boolean>[],
): Record<string, any>
Flatten an object. Any properties that are collections will get converted to an array of keys.
Parameters
- OptionalpropsRecursive: boolean
  Optional. If true, calls toJSON method on nested objects.
- ...props: Record<string, string | boolean>[]
  Optional. Specific properties to include/exclude, or rename.
Returns Record<string, any>
Flattened object.

Inherited from Base.toJSON

valueOf

valueOf(): string | null
Returns the id instance Chat, User, ChatMember and other

Returns string | null
Inherited from Base.valueOf