Skip to content

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

Class: InputChecklistTask

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

Describes a task to add to a checklist.

Documentation

Constructors

Constructor

new InputChecklistTask(payload): InputChecklistTask

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

Parameters

ParameterType
payloadTelegramInputChecklistTask

Returns

InputChecklistTask

Properties

PropertyTypeDefined in
payloadTelegramInputChecklistTaskcontexts/index.d.ts:4095

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

Returns

string


id

Get Signature

get id(): number

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

Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist

Returns

number


parseMode

Get Signature

get parseMode(): "HTML" | "MarkdownV2" | "Markdown"

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

Optional. Mode for parsing entities in the text. See formatting options for more details.

Returns

"HTML" | "MarkdownV2" | "Markdown"


text

Get Signature

get text(): string | { toString: string; }

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

Text of the task; 1-100 characters after entities parsing

Returns

string | { toString: string; }


textEntities

Get Signature

get textEntities(): MessageEntity[]

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

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

Returns

MessageEntity[]