Class ChecklistTasksAdded

Hierarchy (View Summary)

Base
- ChecklistTasksAdded

Index

Constructors

Properties

checklistMessage? tasks

Accessors

addedTaskIds addedTasksCount client completedTasks pendingTasks

Methods

_clone _patch _update [iterator] getTaskById getTasksByStatus toJSON valueOf

Constructors

constructor

new ChecklistTasksAdded(
client: TelegramClient | BaseClient,
data: ChecklistTasksAdded,
): ChecklistTasksAdded
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: ChecklistTasksAdded
  Data about a service message about tasks added to a checklist.
Returns ChecklistTasksAdded
Overrides Base.constructor

Properties

`Optional`checklistMessage

checklistMessage?: Message

Message containing the checklist to which the tasks were added

tasks

tasks: ChecklistTask[]

List of tasks added to the checklist

Accessors

addedTaskIds

get addedTaskIds(): number[]
Get task IDs that were added

Returns number[]

addedTasksCount

get addedTasksCount(): number
Get number of tasks added

Returns number

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

completedTasks

get completedTasks(): ChecklistTask[]
Get completed tasks from added tasks

Returns ChecklistTask[]

pendingTasks

get pendingTasks(): ChecklistTask[]
Get pending tasks from added tasks

Returns ChecklistTask[]

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>

getTaskById

getTaskById(id: number): ChecklistTask | null
Get task by ID
Parameters
- id: number
  Task ID
Returns ChecklistTask | null

getTasksByStatus

getTasksByStatus(completed: boolean): ChecklistTask[]
Get tasks by completion status
Parameters
- completed: boolean
  Whether to get completed or pending tasks
Returns 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