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

Class: ChecklistTask

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

Describes a task in a checklist.

Documentation

Constructors

Constructor

new ChecklistTask(payload): ChecklistTask

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

Parameters

Parameter	Type
payload	TelegramChecklistTask

Returns

ChecklistTask

Properties

Property	Type	Defined in
payload	TelegramChecklistTask	contexts/index.d.ts:1750

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

Returns

string

---

completedByChat

Get Signature

get completedByChat(): Chat

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

Optional. Chat that completed the task; omitted if the task wasn't completed by a chat

Returns

Chat

---

completedByUser

Get Signature

get completedByUser(): User

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

Optional. User that completed the task; omitted if the task wasn't completed

Returns

User

---

completionDate

Get Signature

get completionDate(): Date

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

Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed

Returns

Date

---

id

Get Signature

get id(): number

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

Unique identifier of the task

Returns

number

---

text

Get Signature

get text(): string

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

Text of the task

Returns

string

---

textEntities

Get Signature

get textEntities(): MessageEntity[]

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

Optional. Special entities that appear in the task text

Returns

MessageEntity[]