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

Class: PreCheckoutQueryContext<Bot>

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

This object contains information about an incoming pre-checkout query.

Extends

Context<Bot>.Constructor<PreCheckoutQueryContext<Bot>>.PreCheckoutQuery.SendMixin<Bot>.ChatActionMixin<Bot>.CloneMixin<Bot, PreCheckoutQueryContext<Bot>, PreCheckoutQueryContextOptions<Bot>>

Type Parameters

Type Parameter
`Bot` extends `BotLike`

Constructors

Constructor

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

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

Parameters

Parameter	Type
`options`	`PreCheckoutQueryContextOptions`<`Bot`>

Returns

PreCheckoutQueryContext<Bot>

Overrides

Context.constructor

Constructor

new PreCheckoutQueryContext(...args): PreCheckoutQueryContext

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

Parameters

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

Returns

PreCheckoutQueryContext

Overrides

Context<Bot>.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`bot`	`public`	`Bot`	-	`Context`.`bot`	contexts/index.d.ts:4726
`isTopicMessage`	`public`	() => `boolean`	-	`SendMixin`.`isTopicMessage`	contexts/index.d.ts:4863
`payload`	`public`	`TelegramPreCheckoutQuery`	The raw data that is used for this Context	`PreCheckoutQuery`.`payload`	contexts/index.d.ts:6292
`update?`	`public`	`TelegramUpdate`	-	`Context`.`update`	contexts/index.d.ts:4728
`updateId?`	`public`	`number`	-	`Context`.`updateId`	contexts/index.d.ts:4727
`updateType`	`protected`	`UpdateName`	-	`Context`.`updateType`	contexts/index.d.ts:4729

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

MDN

Returns

string

Inherited from

Context.[toStringTag]

businessConnectionId

Get Signature

get businessConnectionId(): string

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

Returns

string

Inherited from

SendMixin.businessConnectionId

chatId

Get Signature

get chatId(): number

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

Returns

number

Inherited from

SendMixin.chatId

currency

Get Signature

get currency(): TelegramCurrencies

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

Three-letter ISO 4217 currency code

Returns

TelegramCurrencies

Inherited from

PreCheckoutQuery.currency

from

Get Signature

get from(): User

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

User who sent the query

Returns

User

Inherited from

PreCheckoutQuery.from

id

Get Signature

get id(): string

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

Unique query identifier

Returns

string

Inherited from

PreCheckoutQuery.id

invoicePayload

Get Signature

get invoicePayload(): string

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

Bot specified invoice payload

Returns

string

Inherited from

PreCheckoutQuery.invoicePayload

orderInfo

Get Signature

get orderInfo(): OrderInfo

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

Order info provided by the user

Returns

OrderInfo

Inherited from

PreCheckoutQuery.orderInfo

senderId

Get Signature

get senderId(): number

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

Sender ID

Returns

number

Inherited from

PreCheckoutQuery.senderId

shippingOptionId

Get Signature

get shippingOptionId(): string

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

Identifier of the shipping option chosen by the user

Returns

string

Inherited from

PreCheckoutQuery.shippingOptionId

threadId

Get Signature

get threadId(): number

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

Returns

number

Inherited from

SendMixin.threadId

totalAmount

Get Signature

get totalAmount(): number

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

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Returns

number

Inherited from

PreCheckoutQuery.totalAmount

Methods

answer()

answer(params): Promise<true>

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

Answers to the pending pre-checkout query. An alias for answerPreCheckoutQuery

Parameters

Parameter	Type
`params`	`Optional`<`AnswerPreCheckoutQueryParams`, `"pre_checkout_query_id"`>

Returns

Promise<true>

answerPreCheckoutQuery()

answerPreCheckoutQuery(params): Promise<true>

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

Answers to the pending pre-checkout query

Parameters

Parameter	Type
`params`	`Optional`<`AnswerPreCheckoutQueryParams`, `"pre_checkout_query_id"`>

Returns

Promise<true>

clone()

clone(options?): PreCheckoutQueryContext

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

Parameters

Parameter	Type
`options?`	`PreCheckoutQueryContextOptions`

Returns

PreCheckoutQueryContext

Inherited from

CloneMixin.clone

createActionController()

createActionController(action, params?): ChatActionController<Bot>

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

Parameters

Parameter	Type
`action`	`SendChatActionAction`
`params?`	`Pick`<`SendChatActionParams`, `"business_connection_id"` \| `"message_thread_id"`> & `object` & `CreateActionControllerParams`

Returns

ChatActionController<Bot>

Deprecated

Creates a controller that when start()ed executes sendChatAction(action) every interval milliseconds until stop()ped

Inherited from

ChatActionMixin.createActionController

getChatBoosts()

getChatBoosts(userId): Promise<TelegramUserChatBoosts>

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

Returns chat boosts by the user

Parameters

Parameter	Type
`userId`	`number`

Returns

Promise<TelegramUserChatBoosts>

Inherited from

SendMixin.getChatBoosts

hasOrderInfo()

hasOrderInfo(): this is Require<PreCheckoutQueryContext<Bot>, "orderInfo">

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

Checks if the query has orderInfo property

Returns

this is Require<PreCheckoutQueryContext<Bot>, "orderInfo">

hasShippingOptionId()

hasShippingOptionId(): this is Require<PreCheckoutQueryContext<Bot>, "shippingOptionId">

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

Checks if the query has shippingOptionId property

Returns

this is Require<PreCheckoutQueryContext<Bot>, "shippingOptionId">

is()

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

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

Type Parameters

Type Parameter
`T` extends `UpdateName`

Parameters

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

Returns

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

Inherited from

Context.is

send()

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

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

Sends message to current chat

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

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

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

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

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

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

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

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

Sends invoice to current user

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendInvoice

sendLocation()

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

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

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

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

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

SendMixin.sendMediaGroup

sendMessageDraft()

sendMessageDraft(params): Promise<true>

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

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

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

SendMixin.sendPaidMedia

sendPhoto()

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

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

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

Sends poll to current chat

Parameters

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

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPoll

sendSticker()

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

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

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

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

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

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

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

stopPoll()

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

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

Stops poll in current chat

Parameters

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

Returns

Promise<Poll>

Inherited from

SendMixin.stopPoll

streamMessage()

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

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

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

SendMixin.streamMessage

Class: PreCheckoutQueryContext<Bot> ​

Extends ​

Type Parameters ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Accessors ​

[toStringTag] ​

Get Signature ​

Returns ​

Inherited from ​

businessConnectionId ​

Get Signature ​

Returns ​

Inherited from ​

chatId ​

Get Signature ​

Returns ​

Inherited from ​

currency ​

Get Signature ​

Returns ​

Inherited from ​

from ​

Get Signature ​

Returns ​

Inherited from ​

id ​

Get Signature ​

Returns ​

Inherited from ​

invoicePayload ​

Get Signature ​

Returns ​

Inherited from ​

orderInfo ​

Get Signature ​

Returns ​

Inherited from ​

senderId ​

Get Signature ​

Returns ​

Inherited from ​

shippingOptionId ​

Get Signature ​

Returns ​

Inherited from ​

threadId ​

Get Signature ​

Returns ​

Inherited from ​

totalAmount ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

answer() ​

Parameters ​

Returns ​

answerPreCheckoutQuery() ​

Parameters ​

Returns ​

clone() ​

Parameters ​

Returns ​

Inherited from ​

createActionController() ​

Parameters ​

Returns ​

Deprecated ​

Inherited from ​

getChatBoosts() ​

Parameters ​

Class: PreCheckoutQueryContext<Bot>

Extends

Type Parameters

Constructors

Constructor

Parameters

Returns

Overrides

Constructor

Parameters

Returns

Overrides

Properties

Accessors

[toStringTag]

Get Signature

Returns

Inherited from

businessConnectionId

Get Signature

Returns

Inherited from

chatId

Get Signature

Returns

Inherited from

currency

Get Signature

Returns

Inherited from

from

Get Signature

Returns

Inherited from

id

Get Signature

Returns

Inherited from

invoicePayload

Get Signature

Returns

Inherited from

orderInfo

Get Signature

Returns

Inherited from

senderId

Get Signature

Returns

Inherited from

shippingOptionId

Get Signature

Returns

Inherited from

threadId

Get Signature

Returns

Inherited from

totalAmount

Get Signature

Returns

Inherited from

Methods

answer()

Parameters

Returns

answerPreCheckoutQuery()

Parameters

Returns

clone()

Parameters

Returns

Inherited from

createActionController()

Parameters

Returns

Deprecated

Inherited from

getChatBoosts()

Parameters