Class Checklist

Hierarchy (View Summary)

Constructors

constructor

Properties

entities? othersCanAddTasks? othersCanMarkTasksAsDone? tasks title

Accessors

client completedTasks completedTasksCount pendingTasks totalTasks

Methods

_clone _patch _update [iterator] toJSON valueOf

Constructors

constructor

Properties

Optionalentities

entities?: MessageEntities

Special entities that appear in the checklist title

OptionalothersCanAddTasks

othersCanAddTasks?: true

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

OptionalothersCanMarkTasksAsDone

othersCanMarkTasksAsDone?: true

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

tasks

tasks: ChecklistTask[]

List of tasks in the checklist

title

title: string

Title of the checklist

Accessors

client

completedTasks

completedTasksCount

  • get completedTasksCount(): number

  • Get number of completed tasks

    Returns number

pendingTasks

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

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

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

[iterator]

  • "[iterator]"(): IterableIterator<ChecklistTask, any, any>

  • Makes the class iterable, returning each check task list

    Returns IterableIterator<ChecklistTask, any, any>

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.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods