Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Functions

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

Creates InlineKeyboardMarkup using internal matrix

Link copied to clipboard
Link copied to clipboard

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: ReplyKeyboardRowBuilder.() -> Unit): ReplyKeyboardMarkup

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
inline fun InlineKeyboardRowBuilder.inlineQueryInChosenChatButton(text: String, query: String? = null, allowUsers: Boolean = false, allowBots: Boolean = false, allowGroups: Boolean = false, allowChannels: Boolean = false): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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

Link copied to clipboard
fun ReplyKeyboardMarkup(vararg buttons: KeyboardButton, resizeKeyboard: Boolean? = null, oneTimeKeyboard: Boolean? = null, inputFieldPlaceholder: String? = null, selective: Boolean? = null, persistent: Boolean? = null): ReplyKeyboardMarkup
Link copied to clipboard
inline fun ReplyKeyboardRowBuilder.requestBotButton(text: String, requestId: RequestId, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean
Link copied to clipboard
inline fun ReplyKeyboardRowBuilder.requestBotsButton(text: String, requestId: RequestId, maxCount: Int = keyboardButtonRequestUserLimit.first, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
inline fun ReplyKeyboardRowBuilder.requestUserButton(text: String, requestId: RequestId, premiumUser: Boolean? = null, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean
Link copied to clipboard
inline fun ReplyKeyboardRowBuilder.requestUserOrBotButton(text: String, requestId: RequestId, requestName: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null): Boolean
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Creates and put WebAppKeyboardButton