GramIO API Reference / @gramio/contexts/dist / StreamRichMessageOptions
Interface: StreamRichMessageOptions
Defined in: contexts/index.d.ts:328
Options for Contexts.MessageContext.streamRichMessage | streamRichMessage
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
draftId? | number | Draft identifier (must be non-zero). Updates to the same id are animated by Telegram. Defaults to an internal per-stream counter, so concurrent streams don't collide. | contexts/index.d.ts:333 |
draftParams? | Optional<SendRichMessageDraftParams, "chat_id" | "rich_message" | "draft_id"> | Extra params for sendRichMessageDraft (preview) calls. | contexts/index.d.ts:339 |
messageParams? | Optional<SendRichMessageParams, "chat_id" | "rich_message"> | Extra params for the finalizing sendRichMessage call (e.g. reply_markup, reply_parameters). | contexts/index.d.ts:341 |
richOptions? | Pick<TelegramInputRichMessage, "is_rtl" | "skip_entity_detection"> | Rich options applied to every preview update and the final message. | contexts/index.d.ts:337 |
signal? | AbortSignal | AbortSignal to cancel streaming — disposing an aborted draft skips finalization. | contexts/index.d.ts:343 |
throttle? | number | Minimum milliseconds between draft (preview) updates. Defaults to 1000. | contexts/index.d.ts:335 |