Class PreCheckoutQueryContext

Context of a pre-checkout query update

This is a subclass of PreCheckoutQuery, so all its fields are also available.

Hierarchy (View Summary)

PreCheckoutQuery
- PreCheckoutQueryContext

Implements

UpdateContext<PreCheckoutQuery>

Index

Constructors

Properties

_name _peers client raw

Accessors

currency payload paymentInfo queryId totalAmount user userId

Methods

approve decline

Constructors

constructor

new PreCheckoutQueryContext(
client: TelegramClient,
query: PreCheckoutQuery,
): PreCheckoutQueryContext
Parameters
- client: TelegramClient
- query: PreCheckoutQuery
Returns PreCheckoutQueryContext
Overrides PreCheckoutQuery.constructor
- Defined in packages/dispatcher/src/context/pre-checkout-query.ts:14

Properties

`Readonly`_name

_name: "pre_checkout_query" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`raw

raw: RawUpdateBotPrecheckoutQuery

Accessors

currency

get currency(): string
Currency of the payment

Returns string
Implementation of UpdateContext.currency
Inherited from PreCheckoutQuery.currency
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:55

payload

get payload(): Uint8Array
Bot-defined payload of the original invoice (see InputMediaInvoice.payload)

Returns Uint8Array
Implementation of UpdateContext.payload
Inherited from PreCheckoutQuery.payload
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:39

paymentInfo

get paymentInfo(): null | RawPaymentRequestedInfo
User-provided payment info (like name, phone, shipping address, etc.)

Returns null | RawPaymentRequestedInfo
Implementation of UpdateContext.paymentInfo
Inherited from PreCheckoutQuery.paymentInfo
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:46

queryId

get queryId(): Long
ID of the query

Returns Long
Implementation of UpdateContext.queryId
Inherited from PreCheckoutQuery.queryId
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:17

totalAmount

get totalAmount(): Long
Total price of the payment

Returns Long
Implementation of UpdateContext.totalAmount
Inherited from PreCheckoutQuery.totalAmount
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:62

user

get user(): User
User who sent the query

Returns User
Implementation of UpdateContext.user
Inherited from PreCheckoutQuery.user
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:31

userId

get userId(): number
ID of the user who sent the query

Returns number
Implementation of UpdateContext.userId
Inherited from PreCheckoutQuery.userId
- Defined in packages/core/src/highlevel/types/updates/pre-checkout-query.ts:24

Methods

approve

approve(): Promise<void>
Approve the query

Returns Promise<void>
- Defined in packages/dispatcher/src/context/pre-checkout-query.ts:22

decline

decline(error?: string): Promise<void>
Decline the query, optionally with an error
Parameters
- error: string = ''
Returns Promise<void>
- Defined in packages/dispatcher/src/context/pre-checkout-query.ts:27