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

Class: ChatControlMixin<Bot>

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

This object represents a mixin that is responsible for all the chat management methods

Extends

Context<Bot>.TargetMixin.NodeMixin<Bot>

Extended by

Type Parameters

Type Parameter
`Bot` extends `BotLike`

Constructors

Constructor

new ChatControlMixin<Bot>(): ChatControlMixin<Bot>

Returns

ChatControlMixin<Bot>

Inherited from

Context.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
`bot`	`public`	`Bot`	`Context`.`bot`	contexts/index.d.ts:4856
`isTopicMessage`	`public`	() => `boolean`	`NodeMixin`.`isTopicMessage`	contexts/index.d.ts:4993
`payload`	`public`	`Record`<`string`, `any`>	`TargetMixin`.`payload`	contexts/index.d.ts:4870
`update?`	`public`	`TelegramUpdate`	`Context`.`update`	contexts/index.d.ts:4858
`updateId?`	`public`	`number`	`Context`.`updateId`	contexts/index.d.ts:4857
`updateType`	`protected`	`UpdateName`	`Context`.`updateType`	contexts/index.d.ts:4859

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

MDN

Returns

string

Inherited from

Context.[toStringTag]

businessConnectionId

Get Signature

get businessConnectionId(): string

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

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

Returns

string

Inherited from

TargetMixin.businessConnectionId

chat

Get Signature

get chat(): Chat

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

Conversation the message belongs to

Returns

Chat

Inherited from

TargetMixin.chat

chatId

Get Signature

get chatId(): number

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

Chat ID

Returns

number

Inherited from

TargetMixin.chatId

chatType

Get Signature

get chatType(): TelegramChatType

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

Chat type

Returns

TelegramChatType

Inherited from

TargetMixin.chatType

from

Get Signature

get from(): User

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

Sender, empty for messages sent to channels

Returns

User

Inherited from

TargetMixin.from

id

Get Signature

get id(): number

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

Returns

number

Inherited from

NodeMixin.id

senderBoostCount

Get Signature

get senderBoostCount(): number

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

Optional. If the sender of the message boosted the chat, the number of boosts added by the user

Returns

number

Inherited from

TargetMixin.senderBoostCount

senderChat

Get Signature

get senderChat(): Chat

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

Sender of the message, sent on behalf of a chat. The channel itself for channel messages. The supergroup itself for messages from anonymous group administrators. The linked channel for messages automatically forwarded to the discussion group

Returns

Chat

Inherited from

TargetMixin.senderChat

senderId

Get Signature

get senderId(): number

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

Sender's ID

Returns

number

Inherited from

TargetMixin.senderId

threadId

Get Signature

get threadId(): number

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

Returns

number

Inherited from

NodeMixin.threadId

Methods

clearReactions()

clearReactions(params?): Promise<true>

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

Clears reactions from the message

Parameters

Parameter	Type
`params?`	`Optional`<`SetMessageReactionParams`, `"chat_id"` \| `"message_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.clearReactions

copy()

copy(params?): Promise<MessageId>

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

Copies current message [into other chat if chatId is provided]

Parameters

Parameter	Type
`params?`	`Optional`<`CopyMessageParams`, `"chat_id"` \| `"message_id"` \| `"from_chat_id"`>

Returns

Promise<MessageId>

Inherited from

NodeMixin.copy

copyMessages()

copyMessages(chatId, ids, params?): Promise<MessageId[]>

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

Copies messages from current chat and sends to another

Parameters

Parameter	Type
`chatId`	`string` \| `number`
`ids`	`number`[]
`params?`	`Optional`<`CopyMessagesParams`, `"chat_id"` \| `"message_ids"` \| `"from_chat_id"`>

Returns

Promise<MessageId[]>

Inherited from

NodeMixin.copyMessages

delete()

delete(params?): Promise<true>

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

Deletes current message

Parameters

Parameter	Type
`params?`	`Optional`<`DeleteMessageParams`, `"chat_id"` \| `"message_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.delete

deleteChatStickerSet()

deleteChatStickerSet(params?): Promise<true>

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

Deletes group stickerset

Parameters

Parameter	Type
`params?`	`Optional`<`DeleteChatStickerSetParams`, `"chat_id"`>

Returns

Promise<true>

deleteMessages()

deleteMessages(ids): Promise<true>

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

Deletes messages in current chat

Parameters

Parameter	Type
`ids`	`number`[]

Returns

Promise<true>

Inherited from

NodeMixin.deleteMessages

editCaption()

editCaption(caption, params?): Promise<true | MessageContext<Bot>>

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

Edits current message caption. An alias for editMessageCaption

Parameters

Parameter	Type
`caption`	`NonNullable`<`string` \| { `toString`: `string`; }>
`params?`	`Partial`<`EditMessageCaptionParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editCaption

editChecklist()

editChecklist(checklist, params?): Promise<MessageContext<Bot>>

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

Parameters

Parameter	Type
`checklist`	`TelegramInputChecklist`
`params?`	`Partial`<`EditMessageChecklistParams`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.editChecklist

editLiveLocation()

editLiveLocation(params): Promise<true | MessageContext<Bot>>

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

Edits current message live location. An alias for editMessageLiveLocation

Parameters

Parameter	Type
`params`	`EditMessageLiveLocationParams`

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editLiveLocation

editMedia()

editMedia(media, params?): Promise<true | MessageContext<Bot>>

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

Edits current message media. An alias for editMessageMedia

Parameters

Parameter	Type
`media`	`TelegramInputMedia`
`params?`	`Partial`<`EditMessageMediaParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMedia

editMessageCaption()

editMessageCaption(caption, params?): Promise<true | MessageContext<Bot>>

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

Edits current message caption

Parameters

Parameter	Type
`caption`	`NonNullable`<`string` \| { `toString`: `string`; }>
`params?`	`Partial`<`EditMessageCaptionParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMessageCaption

editMessageLiveLocation()

editMessageLiveLocation(params): Promise<true | MessageContext<Bot>>

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

Edits current message live location

Parameters

Parameter	Type
`params`	`EditMessageLiveLocationParams`

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMessageLiveLocation

editMessageMedia()

editMessageMedia(media, params?): Promise<true | MessageContext<Bot>>

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

Edits current message media

Parameters

Parameter	Type
`media`	`TelegramInputMedia`
`params?`	`Partial`<`EditMessageMediaParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMessageMedia

editMessageReplyMarkup()

editMessageReplyMarkup(replyMarkup, params?): Promise<true | MessageContext<Bot>>

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

Edits current message reply markup

Parameters

Parameter	Type
`replyMarkup`	`TelegramInlineKeyboardMarkup` \| { `toJSON`: `TelegramInlineKeyboardMarkup`; }
`params?`	`Partial`<`EditMessageReplyMarkupParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMessageReplyMarkup

editMessageText()

editMessageText(text, params?): Promise<true | MessageContext<Bot>>

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

Edits current message text

Parameters

Parameter	Type
`text`	`string` \| { `toString`: `string`; }
`params?`	`Partial`<`EditMessageTextParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editMessageText

editReplyMarkup()

editReplyMarkup(replyMarkup, params?): Promise<true | MessageContext<Bot>>

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

Edits current message reply markup. An alias for editMessageReplyMarkup

Parameters

Parameter	Type
`replyMarkup`	`TelegramInlineKeyboardMarkup` \| { `toJSON`: `TelegramInlineKeyboardMarkup`; }
`params?`	`Partial`<`EditMessageReplyMarkupParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editReplyMarkup

editText()

editText(text, params?): Promise<true | MessageContext<Bot>>

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

Edits current message text. An alias for editMessageText

Parameters

Parameter	Type
`text`	`string` \| { `toString`: `string`; }
`params?`	`Partial`<`EditMessageTextParams`>

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.editText

forward()

forward(params?): Promise<MessageContext<Bot>>

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

Forwards current message [into other chat if chatId is provided]

Parameters

Parameter	Type
`params?`	`Optional`<`ForwardMessageParams`, `"chat_id"` \| `"message_id"` \| `"from_chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.forward

forwardMessages()

forwardMessages(chatId, ids, params?): Promise<MessageId[]>

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

Forwards messages from current chat to another

Parameters

Parameter	Type
`chatId`	`string` \| `number`
`ids`	`number`[]
`params?`	`Optional`<`ForwardMessagesParams`, `"chat_id"` \| `"message_ids"` \| `"from_chat_id"`>

Returns

Promise<MessageId[]>

Inherited from

NodeMixin.forwardMessages

getChatBoosts()

getChatBoosts(userId): Promise<TelegramUserChatBoosts>

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

Returns chat boosts by the user

Parameters

Parameter	Type
`userId`	`number`

Returns

Promise<TelegramUserChatBoosts>

Inherited from

NodeMixin.getChatBoosts

hasFrom()

hasFrom(): this is Require<ChatControlMixin<Bot>, "from" | "senderId">

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

Checks if the instance has from and senderId properties

Returns

this is Require<ChatControlMixin<Bot>, "from" | "senderId">

Inherited from

TargetMixin.hasFrom

hasSenderChat()

hasSenderChat(): this is Require<ChatControlMixin<Bot>, "senderChat">

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

Checks if the instance has senderChat property

Returns

this is Require<ChatControlMixin<Bot>, "senderChat">

Inherited from

TargetMixin.hasSenderChat

is()

is<T>(rawTypes): this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})

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

Type Parameters

Type Parameter
`T` extends `UpdateName`

Parameters

Parameter	Type
`rawTypes`	`MaybeArray`<`SoftString`<`T`>>

Returns

this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})

Inherited from

Context.is

isChannel()

isChannel(): this is RequireValue<ChatControlMixin<Bot>, "chatType", Channel>

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

Is this chat a channel?

Returns

this is RequireValue<ChatControlMixin<Bot>, "chatType", Channel>

Inherited from

TargetMixin.isChannel

isGroup()

isGroup(): this is RequireValue<ChatControlMixin<Bot>, "chatType", Group>

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

Is this chat a group?

Returns

this is RequireValue<ChatControlMixin<Bot>, "chatType", Group>

Inherited from

TargetMixin.isGroup

isPM()

isPM(): this is RequireValue<ChatControlMixin<Bot>, "chatType", Private>

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

Is this chat a private one?

Returns

this is RequireValue<ChatControlMixin<Bot>, "chatType", Private>

Inherited from

TargetMixin.isPM

isSupergroup()

isSupergroup(): this is RequireValue<ChatControlMixin<Bot>, "chatType", Supergroup>

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

Is this chat a supergroup?

Returns

this is RequireValue<ChatControlMixin<Bot>, "chatType", Supergroup>

Inherited from

TargetMixin.isSupergroup

quoteWithAnimation()

quoteWithAnimation(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and an animation

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendAnimationParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"show_caption_above_media"` \| `"has_spoiler"` \| `"thumbnail"` \| `"duration"` \| `"width"` \| `"height"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithAnimation

quoteWithAudio()

quoteWithAudio(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and an audio

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendAudioParams`, `"caption"` \| `"title"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"thumbnail"` \| `"duration"` \| `"performer"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithAudio

quoteWithContact()

quoteWithContact(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a contact

Parameters

Parameter	Type
`params`	`object` & `Pick`<`SendContactParams`, `"phone_number"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"first_name"` \| `"last_name"` \| `"vcard"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithContact

quoteWithDice()

quoteWithDice(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a dice

Parameters

Parameter	Type
`params`	`object` & `object` & `Partial`<`SendDiceParams`> & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithDice

quoteWithDocument()

quoteWithDocument(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a document

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendDocumentParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"thumbnail"` \| `"disable_content_type_detection"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithDocument

quoteWithInvoice()

quoteWithInvoice(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and an invoice

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `Pick`<`SendInvoiceParams`, `"payload"` \| `"currency"` \| `"description"` \| `"title"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"provider_token"` \| `"prices"` \| `"max_tip_amount"` \| `"suggested_tip_amounts"` \| `"start_parameter"` \| `"provider_data"` \| `"photo_url"` \| `"photo_size"` \| `"photo_width"` \| `"photo_height"` \| `"need_name"` \| `"need_phone_number"` \| `"need_email"` \| `"need_shipping_address"` \| `"send_phone_number_to_provider"` \| `"send_email_to_provider"` \| `"is_flexible"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithInvoice

quoteWithLocation()

quoteWithLocation(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a location

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendLocationParams`, `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"horizontal_accuracy"` \| `"live_period"` \| `"heading"` \| `"proximity_alert_radius"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithLocation

quoteWithMediaGroup()

quoteWithMediaGroup(params): Promise<MessageContext<Bot>[]>

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

Replies to current message with a quote and a media group

Parameters

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendMediaGroupParams`, `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"reply_parameters"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>[]>

Inherited from

NodeMixin.quoteWithMediaGroup

quoteWithPhoto()

quoteWithPhoto(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a photo

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendPhotoParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"show_caption_above_media"` \| `"has_spoiler"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithPhoto

quoteWithPoll()

quoteWithPoll(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a poll

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `Pick`<`SendPollParams`, `"question"` \| `"options"` \| `"type"` \| `"explanation"` \| `"description"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"reply_parameters"` \| `"reply_markup"` \| `"question_parse_mode"` \| `"question_entities"` \| `"is_anonymous"` \| `"allows_multiple_answers"` \| `"allows_revoting"` \| `"shuffle_options"` \| `"allow_adding_options"` \| `"hide_results_until_closes"` \| `"correct_option_ids"` \| `"explanation_parse_mode"` \| `"explanation_entities"` \| `"open_period"` \| `"close_date"` \| `"is_closed"` \| `"description_parse_mode"` \| `"description_entities"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithPoll

quoteWithSticker()

quoteWithSticker(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a sticker

Parameters

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendStickerParams`, `"emoji"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithSticker

quoteWithVenue()

quoteWithVenue(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a venue

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `Pick`<`SendVenueParams`, `"title"` \| `"address"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"latitude"` \| `"longitude"` \| `"foursquare_id"` \| `"foursquare_type"` \| `"google_place_id"` \| `"google_place_type"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithVenue

quoteWithVideo()

quoteWithVideo(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a video

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendVideoParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"show_caption_above_media"` \| `"has_spoiler"` \| `"thumbnail"` \| `"duration"` \| `"width"` \| `"height"` \| `"cover"` \| `"start_timestamp"` \| `"supports_streaming"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithVideo

quoteWithVideoNote()

quoteWithVideoNote(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a video note

Parameters

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendVideoNoteParams`, `"length"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"thumbnail"` \| `"duration"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithVideoNote

quoteWithVoice()

quoteWithVoice(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote and a voice

Parameters

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendVoiceParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"caption_entities"` \| `"duration"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.quoteWithVoice

react()

react(rawReactions, params?): Promise<true>

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

Reacts to a message

Parameters

Parameter	Type
`rawReactions`	`MaybeArray`<`TelegramReactionTypeEmojiEmoji` \| `TelegramReactionType`>
`params?`	`Optional`<`SetMessageReactionParams`, `"chat_id"` \| `"message_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.react

removeChatPhoto()

removeChatPhoto(params?): Promise<true>

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

Deletes a chat photo

Parameters

Parameter	Type
`params?`	`Optional`<`DeleteChatPhotoParams`, `"chat_id"`>

Returns

Promise<true>

reply()

reply(text, params?): Promise<MessageContext<Bot>>

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

Replies to current message

Parameters

Parameter	Type
`text`	`string` \| { `toString`: `string`; }
`params?`	`WithPartialReplyParameters`<`Optional`<`SendMessageParams`, `"text"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.reply

replyWithAnimation()

replyWithAnimation(animation, params?): Promise<MessageContext<Bot>>

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

Replies to current message with animation

Parameters

Parameter	Type
`animation`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendAnimationParams`, `"animation"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithAnimation

replyWithAudio()

replyWithAudio(audio, params?): Promise<MessageContext<Bot>>

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

Replies to current message with audio

Parameters

Parameter	Type
`audio`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendAudioParams`, `"audio"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithAudio

replyWithContact()

replyWithContact(params): Promise<MessageContext<Bot>>

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

Replies to current message with contact

Parameters

Parameter	Type
`params`	`WithPartialReplyParameters`<`Optional`<`SendContactParams`, `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithContact

replyWithDice()

replyWithDice(emoji, params?): Promise<MessageContext<Bot>>

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

Replies to current message with a dice

Parameters

Parameter	Type
`emoji`	`SendDiceEmoji`
`params?`	`WithPartialReplyParameters`<`Partial`<`SendDiceParams`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithDice

replyWithDocument()

replyWithDocument(document, params?): Promise<MessageContext<Bot>>

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

Replies to current message with document

Parameters

Parameter	Type
`document`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendDocumentParams`, `"document"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithDocument

replyWithInvoice()

replyWithInvoice(params): Promise<MessageContext<Bot>>

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

Replies to current message with invoice

Parameters

Parameter	Type
`params`	`WithPartialReplyParameters`<`Optional`<`SendInvoiceParams`, `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithInvoice

replyWithLocation()

replyWithLocation(latitude, longitude, params?): Promise<MessageContext<Bot>>

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

Replies to current message with location

Parameters

Parameter	Type
`latitude`	`number`
`longitude`	`number`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendLocationParams`, `"chat_id"` \| `"latitude"` \| `"longitude"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithLocation

replyWithMediaGroup()

replyWithMediaGroup(mediaGroup, params?): Promise<MessageContext<Bot>[]>

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

Replies to current message with media group

Parameters

Parameter	Type
`mediaGroup`	(`TelegramInputMediaAudio` \| `TelegramInputMediaDocument` \| `TelegramInputMediaPhoto` \| `TelegramInputMediaVideo`)[]
`params?`	`WithPartialReplyParameters`<`Optional`<`SendMediaGroupParams`, `"chat_id"` \| `"media"`>>

Returns

Promise<MessageContext<Bot>[]>

Inherited from

NodeMixin.replyWithMediaGroup

replyWithPhoto()

replyWithPhoto(photo, params?): Promise<MessageContext<Bot>>

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

Replies to current message with photo

Parameters

Parameter	Type
`photo`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendPhotoParams`, `"photo"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithPhoto

replyWithPoll()

replyWithPoll(params): Promise<MessageContext<Bot>>

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

Replies to current message with poll

Parameters

Parameter	Type
`params`	`WithPartialReplyParameters`<`Optional`<`SendPollParams`, `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithPoll

replyWithQuote()

replyWithQuote(params): Promise<MessageContext<Bot>>

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

Replies to current message with a quote

Parameters

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendMessageParams`, `"entities"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"parse_mode"` \| `"link_preview_options"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"`> & `object` & `object`

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithQuote

replyWithSticker()

replyWithSticker(sticker, params?): Promise<MessageContext<Bot>>

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

Replies to current message with sticker

Parameters

Parameter	Type
`sticker`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendStickerParams`, `"sticker"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithSticker

replyWithVenue()

replyWithVenue(params): Promise<MessageContext<Bot>>

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

Replies to current message with venue

Parameters

Parameter	Type
`params`	`WithPartialReplyParameters`<`Optional`<`SendVenueParams`, `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithVenue

replyWithVideo()

replyWithVideo(video, params?): Promise<MessageContext<Bot>>

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

Replies to current message with video

Parameters

Parameter	Type
`video`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendVideoParams`, `"video"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithVideo

replyWithVideoNote()

replyWithVideoNote(videoNote, params?): Promise<MessageContext<Bot>>

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

Replies to current message with video note

Parameters

Parameter	Type
`videoNote`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendVideoNoteParams`, `"video_note"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithVideoNote

replyWithVoice()

replyWithVoice(voice, params?): Promise<MessageContext<Bot>>

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

Replies to current message with voice

Parameters

Parameter	Type
`voice`	`string` \| `Blob`
`params?`	`WithPartialReplyParameters`<`Optional`<`SendVoiceParams`, `"voice"` \| `"chat_id"`>>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithVoice

send()

send(text, params?): Promise<MessageContext<Bot>>

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

Sends message to current chat

Parameters

Parameter	Type
`text`	`string` \| { `toString`: `string`; }
`params?`	`Optional`<`SendMessageParams`, `"text"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.send

sendAnimation()

sendAnimation(animation, params?): Promise<MessageContext<Bot>>

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

Sends animation to current chat

Parameters

Parameter	Type
`animation`	`string` \| `Blob`
`params?`	`Optional`<`SendAnimationParams`, `"animation"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendAnimation

sendAudio()

sendAudio(audio, params?): Promise<MessageContext<Bot>>

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

Sends audio to current chat

Parameters

Parameter	Type
`audio`	`string` \| `Blob`
`params?`	`Optional`<`SendAudioParams`, `"audio"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendAudio

sendChatAction()

sendChatAction(action, params?): Promise<true>

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

Sends chat action to current chat

Parameters

Parameter	Type
`action`	`SendChatActionAction`
`params?`	`Optional`<`SendChatActionParams`, `"chat_id"` \| `"action"`>

Returns

Promise<true>

Inherited from

NodeMixin.sendChatAction

sendChecklist()

sendChecklist(params): Promise<MessageContext<Bot>>

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

Sends checklist to current chat

Parameters

Parameter	Type
`params`	`Optional`<`SendChecklistParams`, `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendChecklist

sendContact()

sendContact(params): Promise<MessageContext<Bot>>

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

Sends contact to current chat

Parameters

Parameter	Type
`params`	`Optional`<`SendContactParams`, `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendContact

sendDice()

sendDice(emoji, params?): Promise<MessageContext<Bot>>

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

Sends dice

Parameters

Parameter	Type
`emoji`	`SendDiceEmoji`
`params?`	`Partial`<`SendDiceParams`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendDice

sendDocument()

sendDocument(document, params?): Promise<MessageContext<Bot>>

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

Sends document to current chat

Parameters

Parameter	Type
`document`	`string` \| `Blob`
`params?`	`Optional`<`SendDocumentParams`, `"document"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendDocument

sendInvoice()

sendInvoice(params): Promise<MessageContext<Bot>>

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

Sends invoice to current user

Parameters

Parameter	Type
`params`	`Optional`<`SendInvoiceParams`, `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendInvoice

sendLocation()

sendLocation(latitude, longitude, params?): Promise<MessageContext<Bot>>

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

Sends location to current chat

Parameters

Parameter	Type
`latitude`	`number`
`longitude`	`number`
`params?`	`Optional`<`SendLocationParams`, `"chat_id"` \| `"latitude"` \| `"longitude"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendLocation

sendMedia()

sendMedia<T>(query): ReturnType<T extends "animation" ? (animation, params?) => Promise<MessageContext<Bot>> : T extends "audio" ? (audio, params?) => Promise<MessageContext<Bot>> : T extends "document" ? (document, params?) => Promise<MessageContext<Bot>> : T extends "photo" ? (photo, params?) => Promise<MessageContext<Bot>> : T extends "sticker" ? (sticker, params?) => Promise<MessageContext<Bot>> : T extends "video_note" ? (videoNote, params?) => Promise<MessageContext<Bot>> : T extends "video" ? (video, params?) => Promise<MessageContext<...>> : T extends "voice" ? (voice, params?) => Promise<...> : () => never>

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

Automatically uses correct media method to send media

Type Parameters

Type Parameter
`T` extends `string`

Parameters

Parameter	Type
`query`	`object` & `tSendMethods`

Returns

ReturnType<T extends "animation" ? (animation, params?) => Promise<MessageContext<Bot>> : T extends "audio" ? (audio, params?) => Promise<MessageContext<Bot>> : T extends "document" ? (document, params?) => Promise<MessageContext<Bot>> : T extends "photo" ? (photo, params?) => Promise<MessageContext<Bot>> : T extends "sticker" ? (sticker, params?) => Promise<MessageContext<Bot>> : T extends "video_note" ? (videoNote, params?) => Promise<MessageContext<Bot>> : T extends "video" ? (video, params?) => Promise<MessageContext<...>> : T extends "voice" ? (voice, params?) => Promise<...> : () => never>

Example

context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})

Inherited from

NodeMixin.sendMedia

sendMediaGroup()

sendMediaGroup(mediaGroup, params?): Promise<MessageContext<Bot>[]>

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

Sends media group to current chat

Parameters

Parameter	Type
`mediaGroup`	(`TelegramInputMediaAudio` \| `TelegramInputMediaDocument` \| `TelegramInputMediaPhoto` \| `TelegramInputMediaVideo`)[]
`params?`	`Optional`<`SendMediaGroupParams`, `"chat_id"` \| `"media"`>

Returns

Promise<MessageContext<Bot>[]>

Inherited from

NodeMixin.sendMediaGroup

sendMessageDraft()

sendMessageDraft(params): Promise<true>

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

Sends a message draft to the current private chat

Parameters

Parameter	Type
`params`	`Optional`<`SendMessageDraftParams`, `"chat_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.sendMessageDraft

sendPaidMedia()

sendPaidMedia(paidMedia, starCount, params?): Promise<MessageContext<Bot>>

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

Sends paid media to current chat

Parameters

Parameter	Type
`paidMedia`	`TelegramInputPaidMedia`[]
`starCount`	`number`
`params?`	`Optional`<`SendPaidMediaParams`, `"chat_id"` \| `"media"` \| `"star_count"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendPaidMedia

sendPhoto()

sendPhoto(photo, params?): Promise<MessageContext<Bot>>

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

Sends photo to current chat

Parameters

Parameter	Type
`photo`	`string` \| `Blob`
`params?`	`Optional`<`SendPhotoParams`, `"photo"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendPhoto

sendPoll()

sendPoll(params): Promise<MessageContext<Bot>>

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

Sends poll to current chat

Parameters

Parameter	Type
`params`	`Optional`<`SendPollParams`, `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendPoll

sendSticker()

sendSticker(sticker, params?): Promise<MessageContext<Bot>>

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

Sends sticker

Parameters

Parameter	Type
`sticker`	`string` \| `Blob`
`params?`	`Optional`<`SendStickerParams`, `"sticker"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendSticker

sendVenue()

sendVenue(params): Promise<MessageContext<Bot>>

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

Sends venue to current chat

Parameters

Parameter	Type
`params`	`Optional`<`SendVenueParams`, `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendVenue

sendVideo()

sendVideo(video, params?): Promise<MessageContext<Bot>>

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

Sends video to current chat

Parameters

Parameter	Type
`video`	`string` \| `Blob`
`params?`	`Optional`<`SendVideoParams`, `"video"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendVideo

sendVideoNote()

sendVideoNote(videoNote, params?): Promise<MessageContext<Bot>>

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

Sends video note to current chat

Parameters

Parameter	Type
`videoNote`	`string` \| `Blob`
`params?`	`Optional`<`SendVideoNoteParams`, `"video_note"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendVideoNote

sendVoice()

sendVoice(voice, params?): Promise<MessageContext<Bot>>

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

Sends voice to current chat

Parameters

Parameter	Type
`voice`	`string` \| `Blob`
`params?`	`Optional`<`SendVoiceParams`, `"voice"` \| `"chat_id"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.sendVoice

setChatDefaultPermissions()

setChatDefaultPermissions(permissions, params?): Promise<true>

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

Sets default chat permissions

Parameters

Parameter	Type
`permissions`	`TelegramChatPermissions`
`params?`	`Optional`<`SetChatPermissionsParams`, `"chat_id"` \| `"permissions"`>

Returns

Promise<true>

setChatDescription()

setChatDescription(description, params?): Promise<true>

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

Changes chat description

Parameters

Parameter	Type
`description`	`string`
`params?`	`Optional`<`SetChatDescriptionParams`, `"description"` \| `"chat_id"`>

Returns

Promise<true>

setChatPhoto()

setChatPhoto(photo, params?): Promise<true>

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

Sets a new profile photo for the chat

Parameters

Parameter	Type
`photo`	`Blob`
`params?`	`Optional`<`SetChatPhotoParams`, `"photo"` \| `"chat_id"`>

Returns

Promise<true>

setChatStickerSet()

setChatStickerSet(name, params?): Promise<true>

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

Sets new group stickerset

Parameters

Parameter	Type
`name`	`string`
`params?`	`Optional`<`SetChatStickerSetParams`, `"chat_id"` \| `"sticker_set_name"`>

Returns

Promise<true>

setChatTitle()

setChatTitle(title, params?): Promise<true>

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

Changes chat title

Parameters

Parameter	Type
`title`	`string`
`params?`	`Optional`<`SetChatTitleParams`, `"title"` \| `"chat_id"`>

Returns

Promise<true>

setCustomTitle()

setCustomTitle(title, params?): Promise<true>

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

Sets a custom title

Parameters

Parameter	Type
`title`	`string`
`params?`	`Optional`<`SetChatAdministratorCustomTitleParams`, `"chat_id"` \| `"user_id"`>

Returns

Promise<true>

setReaction()

setReaction(reaction, params?): Promise<true>

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

Sets a reaction on a message

Parameters

Parameter	Type
`reaction`	`TelegramReactionTypeEmojiEmoji` \| `TelegramReactionType`
`params?`	`Optional`<`SetMessageReactionParams`, `"chat_id"` \| `"message_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.setReaction

setReactions()

setReactions(rawReactions, params?): Promise<true>

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

Sets multiple amount of reactions on a message

Parameters

Parameter	Type
`rawReactions`	(`TelegramReactionTypeEmojiEmoji` \| `TelegramReactionType`)[]
`params?`	`Optional`<`SetMessageReactionParams`, `"chat_id"` \| `"message_id"`>

Returns

Promise<true>

Inherited from

NodeMixin.setReactions

stopLiveLocation()

stopLiveLocation(params?): Promise<true | MessageContext<Bot>>

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

Stops current message live location. An alias for stopMessageLiveLocation

Parameters

Parameter	Type
`params?`	`StopMessageLiveLocationParams`

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.stopLiveLocation

stopMessageLiveLocation()

stopMessageLiveLocation(params?): Promise<true | MessageContext<Bot>>

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

Stops current message live location

Parameters

Parameter	Type
`params?`	`StopMessageLiveLocationParams`

Returns

Promise<true | MessageContext<Bot>>

Inherited from

NodeMixin.stopMessageLiveLocation

stopPoll()

stopPoll(messageId, params?): Promise<Poll>

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

Stops poll in current chat

Parameters

Parameter	Type
`messageId`	`number`
`params?`	`Partial`<`StopPollParams`>

Returns

Promise<Poll>

Inherited from

NodeMixin.stopPoll

streamMessage()

streamMessage(stream, options?): Promise<MessageContext<Bot>[]>

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

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities). Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment. Returns an array of sent MessageContext objects.

Parameters

Parameter	Type
`stream`	`Iterable`<`MessageDraftPiece`, `any`, `any`> \| `AsyncIterable`<`MessageDraftPiece`, `any`, `any`>
`options?`	`StreamMessageOptions`

Returns

Promise<MessageContext<Bot>[]>

Example

// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);

Inherited from

NodeMixin.streamMessage

Class: ChatControlMixin<Bot> ​

Extends ​

Extended by ​

Type Parameters ​

Constructors ​

Constructor ​

Returns ​

Inherited from ​

Properties ​

Accessors ​

[toStringTag] ​

Get Signature ​

Returns ​

Inherited from ​

businessConnectionId ​

Get Signature ​

Returns ​

Inherited from ​

chat ​

Get Signature ​

Returns ​

Inherited from ​

chatId ​

Get Signature ​

Returns ​

Inherited from ​

chatType ​

Get Signature ​

Returns ​

Inherited from ​

from ​

Get Signature ​

Returns ​

Inherited from ​

id ​

Get Signature ​

Returns ​

Inherited from ​

senderBoostCount ​

Get Signature ​

Returns ​

Inherited from ​

senderChat ​

Get Signature ​

Returns ​

Inherited from ​

senderId ​

Get Signature ​

Returns ​

Inherited from ​

threadId ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

clearReactions() ​

Parameters ​

Returns ​

Inherited from ​

copy() ​

Parameters ​

Returns ​

Inherited from ​

copyMessages() ​

Parameters ​

Returns ​

Inherited from ​

delete() ​

Parameters ​

Returns ​

Inherited from ​

deleteChatStickerSet() ​

Parameters ​

Returns ​

deleteMessages() ​

Parameters ​

Returns ​

Inherited from ​

editCaption() ​

Parameters ​

Class: ChatControlMixin<Bot>

Extends

Extended by

Type Parameters

Constructors

Constructor

Returns

Inherited from

Properties

Accessors

[toStringTag]

Get Signature

Returns

Inherited from

businessConnectionId

Get Signature

Returns

Inherited from

chat

Get Signature

Returns

Inherited from

chatId

Get Signature

Returns

Inherited from

chatType

Get Signature

Returns

Inherited from

from

Get Signature

Returns

Inherited from

id

Get Signature

Returns

Inherited from

senderBoostCount

Get Signature

Returns

Inherited from

senderChat

Get Signature

Returns

Inherited from

senderId

Get Signature

Returns

Inherited from

threadId

Get Signature

Returns

Inherited from

Methods

clearReactions()

Parameters

Returns

Inherited from

copy()

Parameters

Returns

Inherited from

copyMessages()

Parameters

Returns

Inherited from

delete()

Parameters

Returns

Inherited from

deleteChatStickerSet()

Parameters

Returns

deleteMessages()

Parameters

Returns

Inherited from

editCaption()

Parameters