InlineKeyboardButton
class InlineKeyboardButton
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
Methods
No description
Label text on the button.
Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=
Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.
Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.
Optional. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row.
Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
Details
at line 21
__construct(string $text, string|null $url = null, string|null $callback_data = null, WebAppInfo|null $web_app = null, LoginUrl|null $login_url = null, string|null $switch_inline_query = null, string|null $switch_inline_query_current_chat = null, CallbackGameInterface|null $callback_game = null, bool|null $pay = null)
No description
at line 37
string
getText()
Label text on the button.
at line 45
string|null
getUrl()
Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=
at line 53
string|null
getCallbackData()
Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
at line 61
WebAppInfo|null
getWebApp()
Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.
at line 69
LoginUrl|null
getLoginUrl()
Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
at line 77
string|null
getSwitchInlineQuery()
Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
at line 85
string|null
getSwitchInlineQueryCurrentChat()
Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.
at line 93
CallbackGameInterface|null
getCallbackGame()
Optional. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row.
at line 101
bool|null
getPay()
Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.