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

Package-level declarations

Types

typealias InlineKeyboardBuilder = MatrixBuilder<InlineKeyboardButton>

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

InlineKeyboardRowBuilder

typealias InlineKeyboardRowBuilder = RowBuilder<InlineKeyboardButton>

Row builder of InlineKeyboardBuilder

ReplyKeyboardBuilder

typealias ReplyKeyboardBuilder = MatrixBuilder<KeyboardButton>

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

ReplyKeyboardRowBuilder

typealias ReplyKeyboardRowBuilder = RowBuilder<KeyboardButton>

Row builder of KeyboardButton

Functions

build

fun InlineKeyboardBuilder.build(): InlineKeyboardMarkup

fun ReplyKeyboardBuilder.build(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null): ReplyKeyboardMarkup

Creates InlineKeyboardMarkup using internal matrix

copyTextButton

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

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

Creates CopyTextButton

dataButton

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

Creates and put CallbackDataInlineKeyboardButton

flatInlineKeyboard

inline fun flatInlineKeyboard(block: InlineKeyboardRowBuilder.() -> Unit): InlineKeyboardMarkup

Factory-function for InlineKeyboardBuilder, but in difference with inlineKeyboard this function will create single-row inline keyboard

flatReplyKeyboard

inline fun flatReplyKeyboard(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null, block: ReplyKeyboardRowBuilder.() -> Unit): ReplyKeyboardMarkup

Factory-function for ReplyKeyboardBuilder, but in difference with replyKeyboard this method will create single-row keyboard

gameButton

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

Creates and put CallbackGameInlineKeyboardButton

inlineKeyboard

inline fun inlineKeyboard(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

inlineQueryInAnyChosenChatButton

inline fun InlineKeyboardRowBuilder.inlineQueryInAnyChosenChatButton(text: String, query: String? = null): Boolean

inlineQueryInChosenChatButton

inline fun InlineKeyboardRowBuilder.inlineQueryInChosenChatButton(text: String, parameters: SwitchInlineQueryChosenChat): Boolean

inline fun InlineKeyboardRowBuilder.inlineQueryInChosenChatButton(text: String, query: String? = null, allowUsers: Boolean = false, allowBots: Boolean = false, allowGroups: Boolean = false, allowChannels: Boolean = false): Boolean

Creates and put SwitchInlineQueryChosenChatInlineKeyboardButton

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

modified

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

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

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, persistent: Boolean? = null, 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, persistent: Boolean? = null): ReplyKeyboardMarkup

requestBotButton

inline fun ReplyKeyboardRowBuilder.requestBotButton(text: String, requestId: RequestId, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Bot

requestBotsButton

inline fun ReplyKeyboardRowBuilder.requestBotsButton(text: String, requestId: RequestId, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Bot

requestChannelButton

inline fun ReplyKeyboardRowBuilder.requestChannelButton(text: String, requestId: RequestId, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: ChatCommonAdministratorRights? = null, botRightsInChat: ChatCommonAdministratorRights? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat.Channel

requestChatButton

inline fun ReplyKeyboardRowBuilder.requestChatButton(text: String, requestChat: KeyboardButtonRequestChat): Boolean

Creates and put RequestChatKeyboardButton

inline fun ReplyKeyboardRowBuilder.requestChatButton(text: String, requestId: RequestId, isChannel: Boolean? = null, isForum: Boolean? = null, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: ChatCommonAdministratorRights? = null, botRightsInChat: ChatCommonAdministratorRights? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat

requestContactButton

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

Creates and put RequestContactKeyboardButton

requestGroupButton

inline fun ReplyKeyboardRowBuilder.requestGroupButton(text: String, requestId: RequestId, isForum: Boolean? = null, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: ChatCommonAdministratorRights? = null, botRightsInChat: ChatCommonAdministratorRights? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat.Group

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

requestUserButton

inline fun ReplyKeyboardRowBuilder.requestUserButton(text: String, requestId: RequestId, premiumUser: Boolean? = null, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Common

requestUserOrBotButton

inline fun ReplyKeyboardRowBuilder.requestUserOrBotButton(text: String, requestId: RequestId, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Any

requestUsersButton

inline fun ReplyKeyboardRowBuilder.requestUsersButton(text: String, requestUser: KeyboardButtonRequestUsers): Boolean

Creates and put RequestUserKeyboardButton

inline fun ReplyKeyboardRowBuilder.requestUsersButton(text: String, requestId: RequestId, premiumUser: Boolean? = null, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Common

requestUsersOrBotsButton

inline fun ReplyKeyboardRowBuilder.requestUsersOrBotsButton(text: String, requestId: RequestId, premiumUser: Boolean? = null, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Any

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

webAppButton

inline fun InlineKeyboardRowBuilder.webAppButton(text: String, webApp: WebAppInfo): Boolean

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

Creates and put WebAppInlineKeyboardButton. Please, remember that this button is available in private chats only

inline fun ReplyKeyboardRowBuilder.webAppButton(text: String, webApp: WebAppInfo): Boolean

inline fun ReplyKeyboardRowBuilder.webAppButton(text: String, url: String): Boolean

Creates and put WebAppKeyboardButton