docs/dev.inmo.tgbotapi.extensions.utils.types.buttons

Package dev.inmo.tgbotapi.extensions.utils.types.buttons

Types

InlineKeyboardBuilder

class InlineKeyboardBuilder : MatrixBuilder<InlineKeyboardButton>

Core DSL part of Inline Keyboard DSL. Can accept only InlineKeyboardButton and returns ready to use InlineKeyboardMarkup via build method

InlineKeyboardRowBuilder

class InlineKeyboardRowBuilder : RowBuilder<InlineKeyboardButton>

Row builder of InlineKeyboardBuilder

ReplyKeyboardBuilder

class ReplyKeyboardBuilder : MatrixBuilder<KeyboardButton>

Core DSL part of Keyboard DSL. Can accept only KeyboardButton and returns ready to use ReplyKeyboardMarkup via build method

ReplyKeyboardRowBuilder

class ReplyKeyboardRowBuilder : RowBuilder<KeyboardButton>

Row builder of KeyboardButton

Functions

dataButton

inline fun InlineKeyboardRowBuilder.dataButton(text: String, data: String): Boolean

Creates and put CallbackDataInlineKeyboardButton

gameButton

inline fun InlineKeyboardRowBuilder.gameButton(text: String): Boolean

Creates and put CallbackGameInlineKeyboardButton

inlineKeyboard

inline fun inlineKeyboard(crossinline block: InlineKeyboardBuilder.() -> Unit): InlineKeyboardMarkup

Factory-function for InlineKeyboardBuilder. It will apply to internally created InlineKeyboardMarkup and InlineKeyboardBuilder.build then

InlineKeyboardMarkup

fun InlineKeyboardMarkup(vararg buttons: InlineKeyboardButton): InlineKeyboardMarkup

inlineQueryButton

inline fun InlineKeyboardRowBuilder.inlineQueryButton(text: String, data: String): Boolean

Creates and put SwitchInlineQueryInlineKeyboardButton

inlineQueryInCurrentChatButton

inline fun InlineKeyboardRowBuilder.inlineQueryInCurrentChatButton(text: String, data: String): Boolean

Creates and put SwitchInlineQueryCurrentChatInlineKeyboardButton

loginButton

inline fun InlineKeyboardRowBuilder.loginButton(text: String, loginUrl: LoginURL): Boolean

Creates and put LoginURLInlineKeyboardButton

payButton

inline fun InlineKeyboardRowBuilder.payButton(text: String): Boolean

Creates and put PayInlineKeyboardButton

replyKeyboard

inline fun replyKeyboard(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, crossinline block: ReplyKeyboardBuilder.() -> Unit): ReplyKeyboardMarkup

Factory-function for ReplyKeyboardBuilder. It will apply to internally created ReplyKeyboardMarkup and ReplyKeyboardBuilder.build then

ReplyKeyboardMarkup

fun ReplyKeyboardMarkup(vararg buttons: KeyboardButton, resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null): ReplyKeyboardMarkup

requestContactButton

inline fun ReplyKeyboardRowBuilder.requestContactButton(text: String): Boolean

Creates and put RequestContactKeyboardButton

requestLocationButton

inline fun ReplyKeyboardRowBuilder.requestLocationButton(text: String): Boolean

Creates and put RequestLocationKeyboardButton

requestPollButton

inline fun ReplyKeyboardRowBuilder.requestPollButton(text: String, pollType: KeyboardButtonPollType): Boolean

Creates and put RequestPollKeyboardButton

row

inline fun InlineKeyboardBuilder.row(crossinline block: InlineKeyboardRowBuilder.() -> Unit): Boolean

Creates an InlineKeyboardRowBuilder and apply with this builder

inline fun ReplyKeyboardBuilder.row(crossinline block: ReplyKeyboardRowBuilder.() -> Unit): Boolean

Creates an ReplyKeyboardRowBuilder and apply with this builder

simpleButton

inline fun ReplyKeyboardRowBuilder.simpleButton(text: String): Boolean

Creates and put SimpleKeyboardButton

urlButton

inline fun InlineKeyboardRowBuilder.urlButton(text: String, url: String): Boolean

Creates and put URLInlineKeyboardButton