sendChecklist

Send a checklist. USER-ONLY

Parameters

chatId: ID

The identifier of a chat to send the checklist to.

title: string

The checklist’s title.

The checklist’s items.

titleEntities?: MessageEntity[]

The entities of the to-do list’s title.

titleParseMode?: ParseMode

The parse mode to use for the title. If omitted, the default parse mode will be used.

isExtendableByOthers?: boolean

Whether users other than the creator of the to-do list can add more items.

isCompletableByOthers?: boolean

Whether users other than the creator of the to-do-list can mark items as completed.

isSilent?: boolean

Whether to send the message in a silent way without making a sound on the recipients’ clients.

isContentProtected?: boolean

Whether to protect the contents of the message from copying and forwarding.

replyTo?: ReplyTo

Information on what the message is replying to.

messageThreadId?: number

The identifier of a thread to send the message to.

sendAs?: ID

The identifier of a chat to send the message on behalf of. User-only.

effectId?: number

The identifier of a message effect to be attached to the message.

sendAt?: number

If specified, the message will be scheduled to be sent at that date. User-only.

businessConnectionId?: string

The identifier of a business connection to perform the action on. Bot-only.

isPaidBroadcast?: boolean

Whether the message is a broadcast that is going to be paid for. Bot-only.

Result

The sent checklist.

Syntax

// Required parameters only.
await client.sendChecklist(chatId, title, items);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.sendChecklist(chatId, title, items, {
    titleEntities,
    titleParseMode,
    isExtendableByOthers,
    isCompletableByOthers,
    isSilent,
    isContentProtected,
    replyTo,
    messageThreadId,
    sendAs,
    effectId,
    sendAt,
    businessConnectionId,
    isPaidBroadcast,
});