Class CallbackQueryContext

Context of a callback query update.

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

Hierarchy (view full)

CallbackQuery
- CallbackQueryContext

Implements

UpdateContext<CallbackQuery>

Index

Constructors

constructor

new CallbackQueryContext(client, query): CallbackQueryContext
Parameters
- client: TelegramClient
- query: CallbackQuery
Returns CallbackQueryContext
Overrides CallbackQuery.constructor
- Defined in packages/dispatcher/src/context/callback-query.ts:15

Properties

`Readonly`_name

_name: "callback_query" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`raw

raw: RawUpdateBotCallbackQuery

Accessors

chat

get chat(): Chat
Chat where the originating message was sent

Returns Chat
Implementation of UpdateContext.chat
Inherited from CallbackQuery.chat
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:94

data

get data(): null | Uint8Array
Data that was contained in the callback button, if any

Note that this field is defined by the client, and a bad client can send arbitrary data in this field.

Returns null | Uint8Array
Implementation of UpdateContext.data
Inherited from CallbackQuery.data
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:51

dataStr

get dataStr(): null | string
Data that was contained in the callback button, if any, parsed as a UTF8 string

Note that this field is defined by the client, and a bad client can send arbitrary data in this field.

Returns null | string
Implementation of UpdateContext.dataStr
Inherited from CallbackQuery.dataStr
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:62

game

get game(): null | string
In case this message was from InputInlineResultGame, or the button was BotKeyboard.game, short name of the game that should be returned.

Returns null | string
Implementation of UpdateContext.game
Inherited from CallbackQuery.game
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:73

id

get id(): Long
ID of this callback query

Returns Long
Implementation of UpdateContext.id
Inherited from CallbackQuery.id
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:26

messageId

get messageId(): number
Identifier of the message containing the button which was clicked.

Returns number
Implementation of UpdateContext.messageId
Inherited from CallbackQuery.messageId
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:105

uniqueChatId

get uniqueChatId(): Long
Unique ID, that represents the chat to which the inline message was sent. Does not contain actual chat ID.

Returns Long
Implementation of UpdateContext.uniqueChatId
Inherited from CallbackQuery.uniqueChatId
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:41

user

get user(): User
User who has pressed the button

Returns User
Implementation of UpdateContext.user
Inherited from CallbackQuery.user
- Defined in packages/core/src/highlevel/types/updates/callback-query.ts:33

Methods

answer

answer(params): Promise<void>
Answer to this callback query
Parameters
- params: undefined | {
      alert?: boolean;
      cacheTime?: number;
      text?: string;
      url?: string;
  }
Returns Promise<void>
- Defined in packages/dispatcher/src/context/callback-query.ts:23

editMessage

editMessage(params): Promise<Message>
Edit the message that contained the callback button that was clicked.
Parameters
- params: Omit<{
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      media?: InputMediaLike;
      messageId: string | TypeInputBotInlineMessageID;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
      text?: InputText;
  }, "messageId">
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/callback-query.ts:40

editMessageWith

editMessageWith(handler): Promise<undefined | Message>
Shortcut for getting the message and editing it.
Parameters
- handler: ((msg: Message) => MaybePromise<Omit<{
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      media?: InputMediaLike;
      messageId: string | TypeInputBotInlineMessageID;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
      text?: InputText;
  }, "messageId">>)
  - - (msg): MaybePromise<Omit<{
          disableWebPreview?: boolean;
          invertMedia?: boolean;
          media?: InputMediaLike;
          messageId: string | TypeInputBotInlineMessageID;
          progressCallback?: ((uploaded: number, total: number) => void);
          replyMarkup?: ReplyMarkup;
          text?: InputText;
      }, "messageId">>
    - Parameters
      msg: Message
      Returns MaybePromise<Omit<{
          disableWebPreview?: boolean;
          invertMedia?: boolean;
          media?: InputMediaLike;
          messageId: string | TypeInputBotInlineMessageID;
          progressCallback?: ((uploaded: number, total: number) => void);
          replyMarkup?: ReplyMarkup;
          text?: InputText;
      }, "messageId">>
Returns Promise<undefined | Message>
- Defined in packages/dispatcher/src/context/callback-query.ts:51

getMessage

getMessage(): Promise<null | Message>
Get the message containing the callback button being clicked.

Note that the message may have been deleted, in which case null will be returned.

Returns Promise<null | Message>
- Defined in packages/dispatcher/src/context/callback-query.ts:33

Class CallbackQueryContext

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CallbackQueryContext

Properties

Readonly_name

Readonly_peers

Readonlyclient

Readonlyraw

Accessors

chat

Returns Chat

data

Returns null | Uint8Array

dataStr

Returns null | string

game

Returns null | string

id

Returns Long

messageId

Returns number

uniqueChatId

Returns Long

user

Returns User

Methods

answer

Parameters

Returns Promise<void>

editMessage

Parameters

Returns Promise<Message>

editMessageWith

Parameters

Parameters

Returns MaybePromise<Omit<{ disableWebPreview?: boolean; invertMedia?: boolean; media?: InputMediaLike; messageId: string | TypeInputBotInlineMessageID; progressCallback?: ((uploaded: number, total: number) => void); replyMarkup?: ReplyMarkup; text?: InputText; }, "messageId">>

Returns Promise<undefined | Message>

getMessage

Returns Promise<null | Message>

Settings

On This Page

`Readonly`_name

`Readonly`_peers

`Readonly`client

`Readonly`raw

Returns MaybePromise<Omit<{
disableWebPreview?: boolean;
invertMedia?: boolean;
media?: InputMediaLike;
messageId: string | TypeInputBotInlineMessageID;
progressCallback?: ((uploaded: number, total: number) => void);
replyMarkup?: ReplyMarkup;
text?: InputText;
}, "messageId">>