GramIO API Reference / @gramio/contexts/dist / Checklist

Class: Checklist

Defined in: contexts/index.d.ts:1516

Describes a checklist.

Documentation

Constructors

Constructor

new Checklist(payload): Checklist

Defined in: contexts/index.d.ts:1518

Parameters

Parameter	Type
payload	TelegramChecklist

Returns

Checklist

Properties

Property	Type	Defined in
payload	TelegramChecklist	contexts/index.d.ts:1517

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: contexts/index.d.ts:1519

Returns

string

---

othersCanAddTasks

Get Signature

get othersCanAddTasks(): true

Defined in: contexts/index.d.ts:1535

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

Returns

true

---

othersCanMarkTasksAsDone

Get Signature

get othersCanMarkTasksAsDone(): true

Defined in: contexts/index.d.ts:1539

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

Returns

true

---

tasks

Get Signature

get tasks(): ChecklistTask[]

Defined in: contexts/index.d.ts:1531

List of tasks in the checklist

Returns

ChecklistTask[]

---

title

Get Signature

get title(): string

Defined in: contexts/index.d.ts:1523

Title of the checklist

Returns

string

---

titleEntities

Get Signature

get titleEntities(): MessageEntity[]

Defined in: contexts/index.d.ts:1527

Optional. Special entities that appear in the checklist title

Returns

MessageEntity[]