Class ChecklistTasksDone

Hierarchy (View Summary)

Base
- ChecklistTasksDone

Index

Constructors

Properties

checklistMessage? markedAsDoneTaskIds? markedAsNotDoneTaskIds?

Accessors

allAffectedTaskIds client doneTasksCount notDoneTasksCount totalAffectedTasks

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

new ChecklistTasksDone(
client: TelegramClient | BaseClient,
data: ChecklistTasksDone,
): ChecklistTasksDone
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: ChecklistTasksDone
  Data about a service message about checklist tasks marked as done or not done.
Returns ChecklistTasksDone
Overrides Base.constructor

Properties

`Optional`checklistMessage

checklistMessage?: Message

Message containing the checklist whose tasks were marked as done or not done

`Optional`markedAsDoneTaskIds

markedAsDoneTaskIds?: number[]

Identifiers of the tasks that were marked as done

`Optional`markedAsNotDoneTaskIds

markedAsNotDoneTaskIds?: number[]

Identifiers of the tasks that were marked as not done

Accessors

allAffectedTaskIds

get allAffectedTaskIds(): number[]
Get all affected task IDs

Returns number[]

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

doneTasksCount

get doneTasksCount(): number
Get number of tasks marked as done

Returns number

notDoneTasksCount

get notDoneTasksCount(): number
Get number of tasks marked as not done

Returns number

totalAffectedTasks

get totalAffectedTasks(): number
Get total number of tasks affected

Returns number

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(): null | string
Returns the id instance Chat, User, ChatMember and other

Returns null | string
Inherited from Base.valueOf