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

Package-level declarations

Types

Link copied to clipboard
typealias InlineKeyboardBuilder = <Error class: unknown class><<Error class: unknown class>>

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

Link copied to clipboard
typealias InlineKeyboardRowBuilder = <Error class: unknown class><<Error class: unknown class>>

Row builder of InlineKeyboardBuilder

Link copied to clipboard
typealias ReplyKeyboardBuilder = <Error class: unknown class><<Error class: unknown class>>

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

Link copied to clipboard
typealias ReplyKeyboardRowBuilder = <Error class: unknown class><<Error class: unknown class>>

Row builder of KeyboardButton

Functions

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.build(): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.build(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null): <Error class: unknown class>

Creates InlineKeyboardMarkup using internal matrix

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.copyTextButton(text: String, data: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.copyTextButton(text: String, data: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates CopyTextButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.dataButton(text: String, data: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put CallbackDataInlineKeyboardButton

Link copied to clipboard
inline fun flatInlineKeyboard(block: <Error class: unknown class><<Error class: unknown class>>.() -> Unit): <Error class: unknown class>

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

Link copied to clipboard
inline fun flatReplyKeyboard(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null, block: <Error class: unknown class><<Error class: unknown class>>.() -> Unit): <Error class: unknown class>

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

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.gameButton(text: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put CallbackGameInlineKeyboardButton

Link copied to clipboard
inline fun inlineKeyboard(block: <Error class: unknown class><<Error class: unknown class>>.() -> Unit): <Error class: unknown class>

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

Link copied to clipboard
fun InlineKeyboardMarkup(vararg buttons: <Error class: unknown class>): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.inlineQueryButton(text: String, data: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put SwitchInlineQueryInlineKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.inlineQueryInAnyChosenChatButton(text: String, query: String? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.inlineQueryInChosenChatButton(text: String, parameters: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.inlineQueryInChosenChatButton(text: String, query: String? = null, allowUsers: Boolean = false, allowBots: Boolean = false, allowGroups: Boolean = false, allowChannels: Boolean = false, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put SwitchInlineQueryChosenChatInlineKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.inlineQueryInCurrentChatButton(text: String, data: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put SwitchInlineQueryCurrentChatInlineKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.loginButton(text: String, loginUrl: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put LoginURLInlineKeyboardButton

Link copied to clipboard
inline fun <Error class: unknown class>.modified(block: <Error class: unknown class><<Error class: unknown class>>.() -> Unit): <Error class: unknown class>

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

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.payButton(text: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put PayInlineKeyboardButton

Link copied to clipboard
inline fun replyKeyboard(resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null, block: <Error class: unknown class><<Error class: unknown class>>.() -> Unit): <Error class: unknown class>

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

Link copied to clipboard
fun ReplyKeyboardMarkup(vararg buttons: <Error class: unknown class>, resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestBotButton(text: String, requestId: <Error class: unknown class>, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Bot

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestBotsButton(text: String, requestId: <Error class: unknown class>, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Bot

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestChannelButton(text: String, requestId: <Error class: unknown class>, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: <Error class: unknown class>? = null, botRightsInChat: <Error class: unknown class>? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat.Channel

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestChatButton(text: String, requestChat: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestChatKeyboardButton

fun <Error class: unknown class><<Error class: unknown class>>.requestChatButton(text: String, requestId: <Error class: unknown class>, isChannel: Boolean? = null, isForum: Boolean? = null, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: <Error class: unknown class>? = null, botRightsInChat: <Error class: unknown class>? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestContactButton(text: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestContactKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestGroupButton(text: String, requestId: <Error class: unknown class>, isForum: Boolean? = null, isPublic: Boolean? = null, isOwnedBy: Boolean? = null, userRightsInChat: <Error class: unknown class>? = null, botRightsInChat: <Error class: unknown class>? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestChatKeyboardButton with KeyboardButtonRequestChat.Group

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestLocationButton(text: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestLocationKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestPollButton(text: String, pollType: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestPollKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestUserButton(text: String, requestId: <Error class: unknown class>, premiumUser: Boolean? = null, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Common

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestUserOrBotButton(text: String, requestId: <Error class: unknown class>, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Any

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestUsersButton(text: String, requestUser: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton

fun <Error class: unknown class><<Error class: unknown class>>.requestUsersButton(text: String, requestId: <Error class: unknown class>, premiumUser: Boolean? = null, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Common

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.requestUsersOrBotsButton(text: String, requestId: <Error class: unknown class>, premiumUser: Boolean? = null, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put RequestUserKeyboardButton with KeyboardButtonRequestUsers.Any

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.simpleButton(text: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put SimpleKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.urlButton(text: String, url: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put URLInlineKeyboardButton

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.webAppButton(text: String, webApp: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.webAppButton(text: String, url: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

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

fun <Error class: unknown class><<Error class: unknown class>>.webAppButton(text: String, webApp: <Error class: unknown class>, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.webAppButton(text: String, url: String, iconCustomEmojiId: <Error class: unknown class>? = null, style: <Error class: unknown class>? = null): <Error class: unknown class>

Creates and put WebAppKeyboardButton