Skip to content
Back to top
View this page

# InputChecklist

class telegram.InputChecklist(title, tasks, parse_mode=None, title_entities=None, others_can_add_tasks=None, others_can_mark_tasks_as_done=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  Describes a checklist to create.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal if their `tasks` is equal.

  Use In

  - `telegram.Bot.edit_message_checklist()`

  - `telegram.Bot.send_checklist()`

  Added in version 22.3.

  Parameters:

    - title (`str`) – Title of the checklist; `1`-`255` characters after entities parsing.

    - parse_mode (`str`, optional) – Mode for parsing entities. See `telegram.constants.ParseMode` and formatting options for more details.

    - title_entities (Sequence[`telegram.MessageEntity`], optional) – List of special entities that appear in the title, which can be specified instead of `parse_mode`. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.

    - tasks (Sequence[`telegram.InputChecklistTask`]) – List of `1`-`30` tasks in the checklist.

    - others_can_add_tasks (`bool`, optional) – Pass `True` if other users can add tasks to the checklist.

    - others_can_mark_tasks_as_done (`bool`, optional) – Pass `True` if other users can mark tasks as done or not done in the checklist.

  title

    Title of the checklist; `1`-`255` characters after entities parsing.

    Type:

      `str`

  parse_mode

    Optional. Mode for parsing entities. See `telegram.constants.ParseMode` and formatting options for more details.

    Type:

      `str`

  title_entities

    Optional. List of special entities that appear in the title, which can be specified instead of `parse_mode`. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.

    Type:

      Sequence[`telegram.MessageEntity`]

  tasks

    List of `1`-`30` tasks in the checklist.

    Type:

      Sequence[`telegram.InputChecklistTask`]

  others_can_add_tasks

    Optional. Pass `True` if other users can add tasks to the checklist.

    Type:

      `bool`

  others_can_mark_tasks_as_done

    Optional. Pass `True` if other users can mark tasks as done or not done in the checklist.

    Type:

      `bool`