Class CallbackQuery

constructor

• new CallbackQuery(
      client: TelegramClient | BaseClient,
      data: CallbackQuery,
  ): CallbackQuery

  Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this

  • data: CallbackQuery

    Data about the represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present

  Returns CallbackQuery

author

chatInstance

Optionaldata

OptionalgameShortName

id

OptionalinlineMessageId

Optionalmessage

send

• send(
      text: string,
      options?: Omit<
          {
              cacheTime?: number;
              callbackQueryId: string;
              showAlert?: boolean;
              text?: string;
              url?: string;
          },
          "text"
          | "callbackQueryId",
      >,
  ): Promise<true>

  Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen

  Parameters

  • text: string

    Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

  • Optionaloptions: Omit<
        {
            cacheTime?: number;
            callbackQueryId: string;
            showAlert?: boolean;
            text?: string;
            url?: string;
        },
        "text"
        | "callbackQueryId",
    >

    out parameters

  Returns Promise<true>

  On success, True is returned.

showAlert

• showAlert(text: string, url?: string, cacheTime?: number): Promise<true>

  Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat as an alert

  Parameters

  • text: string

    Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

  • Optionalurl: string

    URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter

  • OptionalcacheTime: number

    The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0

  Returns Promise<true>

  On success, True is returned.