GramIO API Reference / @gramio/contexts/dist / InputChecklist
Class: InputChecklist
Defined in: contexts/index.d.ts:4584
Describes a checklist to create.
Constructors
Constructor
new InputChecklist(
payload):InputChecklist
Defined in: contexts/index.d.ts:4586
Parameters
| Parameter | Type |
|---|---|
payload | TelegramInputChecklist |
Returns
InputChecklist
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramInputChecklist | contexts/index.d.ts:4585 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:4587
Returns
string
othersCanAddTasks
Get Signature
get othersCanAddTasks():
boolean
Defined in: contexts/index.d.ts:4609
Optional. Pass True if other users can add tasks to the checklist
Returns
boolean
othersCanMarkTasksAsDone
Get Signature
get othersCanMarkTasksAsDone():
boolean
Defined in: contexts/index.d.ts:4613
Optional. Pass True if other users can mark tasks as done or not done in the checklist
Returns
boolean
parseMode
Get Signature
get parseMode():
"HTML"|"MarkdownV2"|"Markdown"
Defined in: contexts/index.d.ts:4597
Optional. Mode for parsing entities in the title. See formatting options for more details.
Returns
"HTML" | "MarkdownV2" | "Markdown"
tasks
Get Signature
get tasks():
InputChecklistTask[]
Defined in: contexts/index.d.ts:4605
List of 1-30 tasks in the checklist
Returns
title
Get Signature
get title():
string| {toString:string; }
Defined in: contexts/index.d.ts:4591
Title of the checklist; 1-255 characters after entities parsing
Returns
string | { toString: string; }
titleEntities
Get Signature
get titleEntities():
MessageEntity[]
Defined in: contexts/index.d.ts:4601
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.