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

Class: MessageReactionContext<Bot>

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

This object represents a change of a reaction on a message performed by a user.

Extends

Context<Bot>.Constructor<MessageReactionContext<Bot>>.MessageReactionUpdated.SendMixin<Bot>.NodeMixin<Bot>.CloneMixin<Bot, MessageReactionContext<Bot>, MessageReactionContextOptions<Bot>>

Type Parameters

Type Parameter
`Bot` extends `BotLike`

Constructors

Constructor

new MessageReactionContext<Bot>(options): MessageReactionContext<Bot>

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

Parameters

Parameter	Type
`options`	`MessageReactionContextOptions`<`Bot`>

Returns

MessageReactionContext<Bot>

Overrides

Context.constructor

Constructor

new MessageReactionContext(...args): MessageReactionContext

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

Parameters

Parameter	Type
...`args`	`any`[]

Returns

MessageReactionContext

Overrides

Context<Bot>.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`bot`	`public`	`Bot`	-	`Context`.`bot`	contexts/index.d.ts:5240
`isTopicMessage`	`public`	() => `boolean`	-	`SendMixin`.`isTopicMessage`	contexts/index.d.ts:5458
`payload`	`public`	`TelegramMessageReactionUpdated`	The raw data that is used for this Context	`MessageReactionUpdated`.`payload`	contexts/index.d.ts:6850
`update?`	`public`	`TelegramUpdate`	-	`Context`.`update`	contexts/index.d.ts:5242
`updateId?`	`public`	`number`	-	`Context`.`updateId`	contexts/index.d.ts:5241
`updateType`	`protected`	`UpdateName`	-	`Context`.`updateType`	contexts/index.d.ts:5243

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

MDN

Returns

string

Inherited from

Context.[toStringTag]

actorChat

Get Signature

get actorChat(): Chat

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

The chat on behalf of which the reaction was changed, if the user is anonymous

Returns

Chat

Inherited from

MessageReactionUpdated.actorChat

businessConnectionId

Get Signature

get businessConnectionId(): string

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

Returns

string

Inherited from

SendMixin.businessConnectionId

chat

Get Signature

get chat(): Chat

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

The chat containing the message the user reacted to

Returns

Chat

Inherited from

MessageReactionUpdated.chat

chatId

Get Signature

get chatId(): number

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

Returns

number

Inherited from

SendMixin.chatId

date

Get Signature

get date(): number

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

Date of the change in Unix time

Returns

number

Inherited from

MessageReactionUpdated.date

id

Get Signature

get id(): number

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

Unique identifier of the message inside the chat

Returns

number

Inherited from

MessageReactionUpdated.id

newReactions

Get Signature

get newReactions(): TelegramReactionType[]

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

New list of reaction types that have been set by the user

Returns

TelegramReactionType[]

Inherited from

MessageReactionUpdated.newReactions

oldReactions

Get Signature

get oldReactions(): TelegramReactionType[]

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

Previous list of reaction types that were set by the user

Returns

TelegramReactionType[]

Inherited from

MessageReactionUpdated.oldReactions

senderId

Get Signature

get senderId(): number

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

Returns

number

Inherited from

SendMixin.senderId

threadId

Get Signature

get threadId(): number

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

Returns

number

Inherited from

SendMixin.threadId

user

Get Signature

get user(): User

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

The user that changed the reaction, if the user isn't anonymous

Returns

User

Inherited from

MessageReactionUpdated.user

Methods

clearReactions()

clearReactions(params?): Promise<true>

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

Clears reactions from the message

Parameters

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

Returns

Promise<true>

Inherited from

NodeMixin.clearReactions

clone()

clone(options?): MessageReactionContext

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

Parameters

Parameter	Type
`options?`	`MessageReactionContextOptions`

Returns

MessageReactionContext

Inherited from

CloneMixin.clone

copy()

copy(params?): Promise<MessageId>

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

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:5727

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:5692

Deletes current message

Parameters

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

Returns

Promise<true>

Inherited from

NodeMixin.delete

deleteAllReactions()

deleteAllReactions(params?): Promise<true>

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

Removes up to 10000 recent reactions in current chat added by a given user or chat

Parameters

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

Returns

Promise<true>

Inherited from

NodeMixin.deleteAllReactions

deleteMessages()

deleteMessages(ids): Promise<true>

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

Deletes messages in current chat

Parameters

Parameter	Type
`ids`	`number`[]

Returns

Promise<true>

Inherited from

NodeMixin.deleteMessages

deleteReaction()

deleteReaction(params?): Promise<true>

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

Removes a reaction from current message

Parameters

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

Returns

Promise<true>

Inherited from

NodeMixin.deleteReaction

editCaption()

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

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

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:5715

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:5702

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:5719

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:5712

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:5700

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:5717

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:5721

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:5708

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:5723

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:5710

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:5729

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:5731

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:5585

Returns chat boosts by the user

Parameters

Parameter	Type
`userId`	`number`

Returns

Promise<TelegramUserChatBoosts>

Inherited from

SendMixin.getChatBoosts

hasActorChat()

hasActorChat(): this is Require<MessageReactionContext<Bot>, "actorChat">

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

Checks if context has the actorChat property

Returns

this is Require<MessageReactionContext<Bot>, "actorChat">

hasUser()

hasUser(): this is Require<MessageReactionContext<Bot>, "user">

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

Checks if context has the user property

Returns

this is Require<MessageReactionContext<Bot>, "user">

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:5249

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

quoteWithAnimation()

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

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

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"` \| `"ephemeral_message_parameters"` \| `"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:5647

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"` \| `"ephemeral_message_parameters"` \| `"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:5680

Replies to current message with a quote and a contact

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `Pick`<`SendContactParams`, `"phone_number"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"ephemeral_message_parameters"` \| `"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:5688

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:5643

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"` \| `"ephemeral_message_parameters"` \| `"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:5676

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:5671

Replies to current message with a quote and a location

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendLocationParams`, `"heading"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"ephemeral_message_parameters"` \| `"disable_notification"` \| `"protect_content"` \| `"allow_paid_broadcast"` \| `"message_effect_id"` \| `"suggested_post_parameters"` \| `"reply_parameters"` \| `"reply_markup"` \| `"horizontal_accuracy"` \| `"live_period"` \| `"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:5667

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:5639

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"` \| `"ephemeral_message_parameters"` \| `"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:5682

Replies to current message with a quote and a poll

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `Pick`<`SendPollParams`, `"question"` \| `"options"` \| `"type"` \| `"explanation"` \| `"description"` \| `"media"` \| `"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"` \| `"members_only"` \| `"country_codes"` \| `"correct_option_ids"` \| `"explanation_parse_mode"` \| `"explanation_entities"` \| `"explanation_media"` \| `"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:5684

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"` \| `"ephemeral_message_parameters"` \| `"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:5678

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"` \| `"ephemeral_message_parameters"` \| `"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:5651

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"` \| `"ephemeral_message_parameters"` \| `"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:5659

Replies to current message with a quote and a video note

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendVideoNoteParams`, `"length"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"ephemeral_message_parameters"` \| `"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:5663

Replies to current message with a quote and a voice

Parameters

Parameter Type

Parameter	Type
`params`	`object` & `object` & `Pick`<`SendVoiceParams`, `"caption"` \| `"business_connection_id"` \| `"message_thread_id"` \| `"direct_messages_topic_id"` \| `"ephemeral_message_parameters"` \| `"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:5737

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

reply()

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

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

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:5613

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:5609

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:5627

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:5633

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:5607

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:5623

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:5621

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:5619

Replies to current message with media group

Parameters

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

Returns

Promise<MessageContext<Bot>[]>

Inherited from

NodeMixin.replyWithMediaGroup

replyWithPhoto()

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

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

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:5629

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:5635

Replies to current message with a quote

Parameters

Parameter Type

Returns

Promise<MessageContext<Bot>>

Inherited from

NodeMixin.replyWithQuote

replyWithSticker()

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

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

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:5625

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:5611

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:5615

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:5617

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:5468

Sends message to current chat.

Pass a @gramio/format RichString (from @gramio/format/rich) and it is sent via sendRichMessage instead — bot.api.* stays 1:1; the method is chosen here.

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.send

sendAnimation()

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

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

Sends animation to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendAnimation

sendAudio()

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

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

Sends audio to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendAudio

sendChatAction()

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

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

Sends chat action to current chat

Parameters

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

Returns

Promise<true>

Inherited from

SendMixin.sendChatAction

sendChecklist()

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

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

Sends checklist to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendChecklist

sendContact()

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

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

Sends contact to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendContact

sendDice()

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

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

Sends dice

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendDice

sendDocument()

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

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

Sends document to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendDocument

sendInvoice()

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

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

Sends invoice to current user

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendInvoice

sendLivePhoto()

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

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

Sends live photo to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendLivePhoto

sendLocation()

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

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

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

SendMixin.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:5559

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

SendMixin.sendMedia

sendMediaGroup()

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

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

Sends media group to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>[]>

Inherited from

SendMixin.sendMediaGroup

sendMessageDraft()

sendMessageDraft(params): Promise<true>

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

Sends a message draft to the current private chat

Parameters

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

Returns

Promise<true>

Inherited from

SendMixin.sendMessageDraft

sendPaidMedia()

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

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

Sends paid media to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPaidMedia

sendPhoto()

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

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

Sends photo to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPhoto

sendPoll()

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

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

Sends poll to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPoll

sendRichMessage()

sendRichMessage(richMessage, params?): Promise<MessageContext<Bot>>

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

Sends rich message to current chat

Parameters

Parameter	Type
`richMessage`	`TelegramInputRichMessage`
`params?`	`Optional`<`SendRichMessageParams`, `"chat_id"` \| `"rich_message"`>

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendRichMessage

sendRichMessageDraft()

sendRichMessageDraft(richMessage, draftId, params?): Promise<true>

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

Streams a partial rich message draft to the current chat. The streamed draft is ephemeral and acts as a temporary 30-second preview — once the output is finalized, you must call sendRichMessage with the complete message to persist it.

Parameters

Parameter	Type
`richMessage`	`TelegramInputRichMessage`
`draftId`	`number`
`params?`	`Optional`<`SendRichMessageDraftParams`, `"chat_id"` \| `"rich_message"` \| `"draft_id"`>

Returns

Promise<true>

Inherited from

SendMixin.sendRichMessageDraft

sendSticker()

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

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

Sends sticker

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendSticker

sendVenue()

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

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

Sends venue to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVenue

sendVideo()

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

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

Sends video to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVideo

sendVideoNote()

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

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

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

SendMixin.sendVideoNote

sendVoice()

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

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

Sends voice to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVoice

setReaction()

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

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

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:5735

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:5706

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:5704

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:5536

Stops poll in current chat

Parameters

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

Returns

Promise<Poll>

Inherited from

SendMixin.stopPoll

streamMessage()

Call Signature

streamMessage(options?): MessageDraft<Bot>

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

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

Two forms (mirroring SendMixin.streamRichMessage):

Iterable — pass an Iterable/AsyncIterable of MessageDraftPiece; it's drained and the array of sent messages is returned.
Handle — call with no iterable to get a MessageDraft: append() pieces and finalize(), or use await using to finalize on scope exit.

Both use sendMessageDraft for live previews and sendMessage to finalize each 4096-char segment.

Parameters

Parameter	Type
`options?`	`StreamMessageOptions`

Returns

MessageDraft<Bot>

Example

// iterable form
const messages = await context.streamMessage(llmStream);

// handle form (auto-finalize)
await using draft = context.streamMessage();
for await (const token of llm) draft.append(token);

Inherited from

SendMixin.streamMessage

Call Signature

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

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

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

Two forms (mirroring SendMixin.streamRichMessage):

Iterable — pass an Iterable/AsyncIterable of MessageDraftPiece; it's drained and the array of sent messages is returned.
Handle — call with no iterable to get a MessageDraft: append() pieces and finalize(), or use await using to finalize on scope exit.

Both use sendMessageDraft for live previews and sendMessage to finalize each 4096-char segment.

Parameters

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

Returns

Promise<MessageContext<Bot>[]>

Example

// iterable form
const messages = await context.streamMessage(llmStream);

// handle form (auto-finalize)
await using draft = context.streamMessage();
for await (const token of llm) draft.append(token);

Inherited from

SendMixin.streamMessage

streamRichMessage()

Call Signature

streamRichMessage(options?): RichMessageDraft<Bot>

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

Stream a rich message to the current chat, draft-first.

The hard part of sendRichMessageDraft is the contract: the draft is an ephemeral ~30-second preview, and you must finalize it with sendRichMessage or the message vanishes. This helper owns that lifecycle (throttled previews, a single finalize), so you can't forget it.

Two forms:

Handle — const draft = ctx.streamRichMessage(); draft.append(chunk); … await draft.finalize(). With await using, finalize runs automatically on scope exit.
Iterable — pass an (async) iterable of chunks; it's drained, finalized, and the sent message is returned.

A chunk is a @gramio/format RichString or a raw rich-markdown string.

Parameters

Parameter	Type
`options?`	`StreamRichMessageOptions`

Returns

RichMessageDraft<Bot>

Example

// handle form (auto-finalize)
await using draft = ctx.streamRichMessage();
for await (const token of llm) draft.append(rich`${token}`);

// iterable form
const message = await ctx.streamRichMessage(llmStream);

Inherited from

SendMixin.streamRichMessage

Call Signature

streamRichMessage(stream, options?): Promise<MessageContext<Bot>>

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

Stream a rich message to the current chat, draft-first.

Two forms:

Handle — const draft = ctx.streamRichMessage(); draft.append(chunk); … await draft.finalize(). With await using, finalize runs automatically on scope exit.
Iterable — pass an (async) iterable of chunks; it's drained, finalized, and the sent message is returned.

A chunk is a @gramio/format RichString or a raw rich-markdown string.

Parameters

Parameter	Type
`stream`	`Iterable`<`RichChunk`, `any`, `any`> \| `AsyncIterable`<`RichChunk`, `any`, `any`>
`options?`	`StreamRichMessageOptions`

Returns

Promise<MessageContext<Bot>>

Example

// handle form (auto-finalize)
await using draft = ctx.streamRichMessage();
for await (const token of llm) draft.append(rich`${token}`);

// iterable form
const message = await ctx.streamRichMessage(llmStream);

Inherited from

SendMixin.streamRichMessage

Class: MessageReactionContext<Bot> ​

Extends ​

Type Parameters ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Accessors ​

[toStringTag] ​

Get Signature ​

Returns ​

Inherited from ​

actorChat ​

Get Signature ​

Returns ​

Inherited from ​

businessConnectionId ​

Get Signature ​

Returns ​

Inherited from ​

chat ​

Get Signature ​

Returns ​

Inherited from ​

chatId ​

Get Signature ​

Returns ​

Inherited from ​

date ​

Get Signature ​

Returns ​

Inherited from ​

id ​

Get Signature ​

Returns ​

Inherited from ​

newReactions ​

Get Signature ​

Returns ​

Inherited from ​

oldReactions ​

Get Signature ​

Returns ​

Inherited from ​

senderId ​

Get Signature ​

Returns ​

Inherited from ​

threadId ​

Get Signature ​

Returns ​

Inherited from ​

user ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

clearReactions() ​

Parameters ​

Returns ​

Inherited from ​

clone() ​

Parameters ​

Returns ​

Inherited from ​

copy() ​

Parameters ​

Returns ​

Inherited from ​

copyMessages() ​

Parameters ​

Returns ​

Inherited from ​

delete() ​

Class: MessageReactionContext<Bot>

Extends

Type Parameters

Constructors

Constructor

Parameters

Returns

Overrides

Constructor

Parameters

Returns

Overrides

Properties

Accessors

[toStringTag]

Get Signature

Returns

Inherited from

actorChat

Get Signature

Returns

Inherited from

businessConnectionId

Get Signature

Returns

Inherited from

chat

Get Signature

Returns

Inherited from

chatId

Get Signature

Returns

Inherited from

date

Get Signature

Returns

Inherited from

id

Get Signature

Returns

Inherited from

newReactions

Get Signature

Returns

Inherited from

oldReactions

Get Signature

Returns

Inherited from

senderId

Get Signature

Returns

Inherited from

threadId

Get Signature

Returns

Inherited from

user

Get Signature

Returns

Inherited from

Methods

clearReactions()

Parameters

Returns

Inherited from

clone()

Parameters

Returns

Inherited from

copy()

Parameters

Returns

Inherited from

copyMessages()

Parameters

Returns

Inherited from

delete()