TgKit library and website are still in early development!

InlineKeyboardButton Class

Represents one button of an inline keyboard. You must use exactly one of the optional fields.

Properties

callbackData string

Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes

See the code

callbackGame CallbackGame

Description of the game that will be launched when the user presses the button.

See the code

loginUrl LoginUrl

An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

See the code

pay boolean

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.

See the code

switchInlineQuery string

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. Can be empty, in which case just the bot's username will be inserted.

See the code

switchInlineQueryCurrentChat string

If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot's username will be inserted.

See the code

text string

Label text on the button

See the code

url string

HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<userId> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.

See the code

webApp WebAppInfo

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.

See the code

Methods

setCallbackData(callbackData: string): InlineKeyboardButton

See the code

setLoginUrl(loginUrl: LoginUrl): InlineKeyboardButton

See the code

setPay(pay: boolean): InlineKeyboardButton

See the code

setSwitchInlineQuery(switchInlineQuery: string): InlineKeyboardButton

See the code

setSwitchInlineQueryCurrentChat(switchInlineQueryCurrentChat: string): InlineKeyboardButton

See the code

setText(text: string): InlineKeyboardButton

See the code

setUrl(url: string): InlineKeyboardButton

See the code

setWebApp(webApp: WebAppInfo): InlineKeyboardButton

See the code

toJSON(): object

See the code