Class Checklist

Hierarchy (View Summary)

Base
- Checklist

Index

Constructors

Properties

entities? othersCanAddTasks? othersCanMarkTasksAsDone? tasks title

Accessors

client completedTasks completedTasksCount pendingTasks totalTasks

Methods

_clone _patch _update [iterator] toJSON valueOf

Constructors

constructor

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

Properties

`Optional`entities

entities?: MessageEntities

Special entities that appear in the checklist title

`Optional`othersCanAddTasks

othersCanAddTasks?: true

True, if users other than the creator of the list can add tasks to the list

`Optional`othersCanMarkTasksAsDone

othersCanMarkTasksAsDone?: true

True, if users other than the creator of the list can mark tasks as done or not done

tasks

tasks: ReadonlyCollection<number, ChecklistTask>

Collection of tasks in the checklist

title

title: string

Title of the checklist

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

completedTasks

get completedTasks(): ReadonlyCollection<
    number,
    ChecklistTask & {
        completedByUser: User;
        completionTimestamp: number;
        completionUnixTime: number;
        isCompleted: true;
    },
>
Get completed tasks

Returns ReadonlyCollection<
    number,
    ChecklistTask & {
        completedByUser: User;
        completionTimestamp: number;
        completionUnixTime: number;
        isCompleted: true;
    },
>

completedTasksCount

get completedTasksCount(): number
Get number of completed tasks

Returns number

pendingTasks

get pendingTasks(): ReadonlyCollection<number, never>
Get pending tasks

Returns ReadonlyCollection<number, never>

totalTasks

get totalTasks(): number
Get total number of tasks

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

[iterator]

"[iterator]"(): IterableIterator<ChecklistTask>
Makes the class iterable, returning each check task list

Returns IterableIterator<ChecklistTask>

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