Class CallbackQueryContext

constructor

• new CallbackQueryContext(
      client: TelegramClient,
      query: CallbackQuery,
  ): CallbackQueryContext

  Parameters

  • client: TelegramClient
  • query: CallbackQuery

  Returns CallbackQueryContext

Readonly_name

Readonlyclient

answer

• answer(
      params:
          | { alert?: boolean; cacheTime?: number; text?: string; url?: string }
          | undefined,
  ): Promise<void>

  Answer to this callback query

  Parameters

  • params: { alert?: boolean; cacheTime?: number; text?: string; url?: string } | undefined
    • { alert?: boolean; cacheTime?: number; text?: string; url?: string }

      • Optionalalert?: boolean

        Whether to show an alert in the middle of the screen instead of a notification at the top of the screen.

        Default

        false
        Copy

      • OptionalcacheTime?: number

        Maximum amount of time in seconds for which this result can be cached by the client (not server!).

        Default

        0
        Copy

      • Optionaltext?: string

        Text of the notification (0-200 chars).

        If not set, nothing will be displayed

      • Optionalurl?: string

        URL that the client should open.

        If this was a button containing a game, you can provide arbitrary link to your game. Otherwise, you can only use links in the format t.me/your_bot?start=... that open your bot with a deep-link parameter.

    • undefined

  Returns Promise<void>

editMessage

• editMessage(
      params: Omit<
          Parameters<TelegramClient["editInlineMessage"]>[0],
          "messageId",
      >,
  ): Promise<Message>

  Edit the message that contained the callback button that was clicked.

  Parameters

  • params: Omit<Parameters<TelegramClient["editInlineMessage"]>[0], "messageId">

  Returns Promise<Message>

editMessageWith

• editMessageWith(
      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",
          >,
      >,
  ): Promise<Message | undefined>

  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",
        >,
    >

  Returns Promise<Message | undefined>

getMessage

• getMessage(): Promise<Message | null>

  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<Message | null>