Class InlineKeyboard

Abstract class containing common logic for all keyboard types. T is the button type (InlineKeyboardButton or KeyboardButton).

Hierarchy (View Summary)

BaseKeyboard<InlineKeyboardButton>
- InlineKeyboard

Index

Constructors

Properties

Methods

addButton build copyText customEmoji game getLastButton loginUrl menu pay row style switchInlineChosenChat switchInlineCurrentChat switchInlineQuery text toJSON url webApp

Constructors

constructor

new InlineKeyboard(): InlineKeyboard
Returns InlineKeyboard
Inherited from BaseKeyboard.constructor

Properties

`Protected`matrix

matrix: InlineKeyboardButton[][] = ...

Methods

`Protected`addButton

addButton(button: InlineKeyboardButton): this
Parameters
- button: InlineKeyboardButton
Returns this
Inherited from BaseKeyboard.addButton
- Defined in core/keyboard.ts:66

build

build(): InlineKeyboardMarkup
Builds the final object (uses this.matrix from the base class)

Returns InlineKeyboardMarkup
- Defined in core/keyboard.ts:138

copyText

copyText(text: string, copy_text: CopyTextButton): this
Parameters
- text: string
- copy_text: CopyTextButton
Returns this
- Defined in core/keyboard.ts:114

customEmoji

customEmoji(emojiId: string): this
Adds a custom emoji to the LAST added button.
Parameters
- emojiId: string
  Unique emoji ID (available for Premium bots)
Returns this
Inherited from BaseKeyboard.customEmoji
- Defined in core/keyboard.ts:46

game

game(text: string, callback_game?: CallbackGame): this
Parameters
- text: string
- callback_game: CallbackGame = {}
Returns this
- Defined in core/keyboard.ts:118

`Protected`getLastButton

getLastButton(): InlineKeyboardButton | undefined
Returns InlineKeyboardButton | undefined
Inherited from BaseKeyboard.getLastButton
- Defined in core/keyboard.ts:74

loginUrl

loginUrl(text: string, login_url: LoginUrl): this
Parameters
- text: string
- login_url: LoginUrl
Returns this
- Defined in core/keyboard.ts:98

menu(text: string, menuId: string, pageId: string): this
Special button for switching between InlineMenu pages
Parameters
- text: string
  Button text
- menuId: string
  Menu ID
- pageId: string
  ID of the page to navigate to
Returns this
- Defined in core/keyboard.ts:132

pay

pay(text: string): this
Parameters
- text: string
Returns this
- Defined in core/keyboard.ts:122

row

row(): this
Starts a new row

Returns this
Inherited from BaseKeyboard.row
- Defined in core/keyboard.ts:37

style

style(style: "danger" | "success" | "primary"): this
Sets the style for the LAST added button.
Parameters
- style: "danger" | "success" | "primary"
  'danger' (red) | 'success' (green) | 'primary' (blue)
Returns this
Inherited from BaseKeyboard.style
- Defined in core/keyboard.ts:56

switchInlineChosenChat

switchInlineChosenChat(
text: string,
chosen_chat: SwitchInlineQueryChosenChat,
): this
Parameters
- text: string
- chosen_chat: SwitchInlineQueryChosenChat
Returns this
- Defined in core/keyboard.ts:110

switchInlineCurrentChat

switchInlineCurrentChat(text: string, query?: string): this
Parameters
- text: string
- query: string = ''
Returns this
- Defined in core/keyboard.ts:106

switchInlineQuery

switchInlineQuery(text: string, query?: string): this
Parameters
- text: string
- query: string = ''
Returns this
- Defined in core/keyboard.ts:102

text

text(text: string, callback_data: string): this
Parameters
- text: string
- callback_data: string
Returns this
- Defined in core/keyboard.ts:86

toJSON

toJSON(): InlineKeyboardMarkup
Allows automatic serialization of the object to JSON

Returns InlineKeyboardMarkup
- Defined in core/keyboard.ts:144

url

url(text: string, url: string): this
Parameters
- text: string
- url: string
Returns this
- Defined in core/keyboard.ts:90

webApp

webApp(text: string, webAppUrl: string): this
Parameters
- text: string
- webAppUrl: string
Returns this
- Defined in core/keyboard.ts:94