docs/dev.inmo.tgbotapi.types.rich/RichMessageButton

RichMessageButton

@Serializable(with = RichMessageButtonSerializer::class)

sealed interface RichMessageButton(source)

A button in a rich message. Every subtype contains exactly one Bot API button action. text may contain only plain text, custom emoji and date-time entities. LoginUrl does not support LoginURL.botUsername.

See also

RichMessageButton

Inheritors

SwitchInlineQuery

SwitchInlineQueryCurrentChat

SwitchInlineQueryChosenChat

Types

@Serializable

data class CallbackData(val text: RichText, val callbackData: String, val style: RichMessageButtonStyle? = null) : RichMessageButton

@Serializable

data class CopyText(val text: RichText, val copyText: CopyTextButtonData, val style: RichMessageButtonStyle? = null) : RichMessageButton

@Serializable

data class Disabled(val text: RichText, val style: RichMessageButtonStyle? = null) : RichMessageButton

@Serializable

data class LoginUrl(val text: RichText, val loginUrl: LoginURL, val style: RichMessageButtonStyle? = null) : RichMessageButton

SwitchInlineQuery

@Serializable

data class SwitchInlineQuery(val text: RichText, val switchInlineQuery: String, val style: RichMessageButtonStyle? = null) : RichMessageButton

SwitchInlineQueryChosenChat

@Serializable

data class SwitchInlineQueryChosenChat(val text: RichText, val switchInlineQueryChosenChat: SwitchInlineQueryChosenChat, val style: RichMessageButtonStyle? = null) : RichMessageButton

SwitchInlineQueryCurrentChat

@Serializable

data class SwitchInlineQueryCurrentChat(val text: RichText, val switchInlineQueryCurrentChat: String, val style: RichMessageButtonStyle? = null) : RichMessageButton

@Serializable

data class Url(val text: RichText, val url: String, val style: RichMessageButtonStyle? = null) : RichMessageButton

@Serializable

data class WebApp(val text: RichText, val webApp: WebAppInfo, val style: RichMessageButtonStyle? = null) : RichMessageButton

Properties

abstract val style: RichMessageButtonStyle?

abstract val text: RichText

Functions

callbackDataOrNull

inline fun RichMessageButton.callbackDataOrNull(): RichMessageButton.CallbackData?

callbackDataOrThrow

inline fun RichMessageButton.callbackDataOrThrow(): RichMessageButton.CallbackData

inline fun RichMessageButton.copyTextOrNull(): RichMessageButton.CopyText?

copyTextOrThrow

inline fun RichMessageButton.copyTextOrThrow(): RichMessageButton.CopyText

inline fun RichMessageButton.disabledOrNull(): RichMessageButton.Disabled?

disabledOrThrow

inline fun RichMessageButton.disabledOrThrow(): RichMessageButton.Disabled

inline fun <T> RichMessageButton.ifCallbackData(block: (RichMessageButton.CallbackData) -> T): T?

inline fun <T> RichMessageButton.ifCopyText(block: (RichMessageButton.CopyText) -> T): T?

inline fun <T> RichMessageButton.ifDisabled(block: (RichMessageButton.Disabled) -> T): T?

inline fun <T> RichMessageButton.ifLoginUrl(block: (RichMessageButton.LoginUrl) -> T): T?

ifSwitchInlineQuery

inline fun <T> RichMessageButton.ifSwitchInlineQuery(block: (RichMessageButton.SwitchInlineQuery) -> T): T?

ifSwitchInlineQueryChosenChat

inline fun <T> RichMessageButton.ifSwitchInlineQueryChosenChat(block: (RichMessageButton.SwitchInlineQueryChosenChat) -> T): T?

ifSwitchInlineQueryCurrentChat

inline fun <T> RichMessageButton.ifSwitchInlineQueryCurrentChat(block: (RichMessageButton.SwitchInlineQueryCurrentChat) -> T): T?

inline fun <T> RichMessageButton.ifUrl(block: (RichMessageButton.Url) -> T): T?

inline fun <T> RichMessageButton.ifWebApp(block: (RichMessageButton.WebApp) -> T): T?

inline fun RichMessageButton.loginUrlOrNull(): RichMessageButton.LoginUrl?

loginUrlOrThrow

inline fun RichMessageButton.loginUrlOrThrow(): RichMessageButton.LoginUrl

switchInlineQueryChosenChatOrNull

inline fun RichMessageButton.switchInlineQueryChosenChatOrNull(): RichMessageButton.SwitchInlineQueryChosenChat?

switchInlineQueryChosenChatOrThrow

inline fun RichMessageButton.switchInlineQueryChosenChatOrThrow(): RichMessageButton.SwitchInlineQueryChosenChat

switchInlineQueryCurrentChatOrNull

inline fun RichMessageButton.switchInlineQueryCurrentChatOrNull(): RichMessageButton.SwitchInlineQueryCurrentChat?

switchInlineQueryCurrentChatOrThrow

inline fun RichMessageButton.switchInlineQueryCurrentChatOrThrow(): RichMessageButton.SwitchInlineQueryCurrentChat

switchInlineQueryOrNull

inline fun RichMessageButton.switchInlineQueryOrNull(): RichMessageButton.SwitchInlineQuery?

switchInlineQueryOrThrow

inline fun RichMessageButton.switchInlineQueryOrThrow(): RichMessageButton.SwitchInlineQuery

abstract fun toRichMarkup(text: String): String

Creates rich HTML or Markdown button markup containing text.

inline fun RichMessageButton.urlOrNull(): RichMessageButton.Url?

inline fun RichMessageButton.urlOrThrow(): RichMessageButton.Url

inline fun RichMessageButton.webAppOrNull(): RichMessageButton.WebApp?

inline fun RichMessageButton.webAppOrThrow(): RichMessageButton.WebApp