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

RichText

@Serializable(with = RichTextSerializer::class)

sealed interface RichText(source)

Represents a rich formatted text. It can be either a plain text (RichTextPlain), a group of rich texts (RichTextGroup) or any of RichTextEntity subtypes.

See also

Inheritors

Properties

abstract val html: String

Rich HTML style representation of this RichText.

abstract val markdown: String

Rich Markdown style representation of this RichText.

abstract val rawText: String

Plain (unformatted) text of this RichText. For RichTextEntitys without an inner RichText it falls back to the most meaningful textual representation: alternative text for custom emojis, the expression for mathematical expressions and an empty string for anchors.

Functions

ifRichTextAnchor

inline fun <T> RichText.ifRichTextAnchor(block: (RichTextAnchor) -> T): T?

ifRichTextAnchorLink

inline fun <T> RichText.ifRichTextAnchorLink(block: (RichTextAnchorLink) -> T): T?

ifRichTextBankCardNumber

inline fun <T> RichText.ifRichTextBankCardNumber(block: (RichTextBankCardNumber) -> T): T?

inline fun <T> RichText.ifRichTextBold(block: (RichTextBold) -> T): T?

ifRichTextBotCommand

inline fun <T> RichText.ifRichTextBotCommand(block: (RichTextBotCommand) -> T): T?

ifRichTextCashtag

inline fun <T> RichText.ifRichTextCashtag(block: (RichTextCashtag) -> T): T?

inline fun <T> RichText.ifRichTextCode(block: (RichTextCode) -> T): T?

ifRichTextCustomEmoji

inline fun <T> RichText.ifRichTextCustomEmoji(block: (RichTextCustomEmoji) -> T): T?

ifRichTextDateTime

inline fun <T> RichText.ifRichTextDateTime(block: (RichTextDateTime) -> T): T?

ifRichTextEmailAddress

inline fun <T> RichText.ifRichTextEmailAddress(block: (RichTextEmailAddress) -> T): T?

ifRichTextEntity

inline fun <T> RichText.ifRichTextEntity(block: (RichTextEntity) -> T): T?

ifRichTextGroup

inline fun <T> RichText.ifRichTextGroup(block: (RichTextGroup) -> T): T?

ifRichTextHashtag

inline fun <T> RichText.ifRichTextHashtag(block: (RichTextHashtag) -> T): T?

ifRichTextItalic

inline fun <T> RichText.ifRichTextItalic(block: (RichTextItalic) -> T): T?

ifRichTextMarked

inline fun <T> RichText.ifRichTextMarked(block: (RichTextMarked) -> T): T?

ifRichTextMathematicalExpression

inline fun <T> RichText.ifRichTextMathematicalExpression(block: (RichTextMathematicalExpression) -> T): T?

ifRichTextMention

inline fun <T> RichText.ifRichTextMention(block: (RichTextMention) -> T): T?

ifRichTextPhoneNumber

inline fun <T> RichText.ifRichTextPhoneNumber(block: (RichTextPhoneNumber) -> T): T?

ifRichTextPlain

inline fun <T> RichText.ifRichTextPlain(block: (RichTextPlain) -> T): T?

ifRichTextReference

inline fun <T> RichText.ifRichTextReference(block: (RichTextReference) -> T): T?

ifRichTextReferenceLink

inline fun <T> RichText.ifRichTextReferenceLink(block: (RichTextReferenceLink) -> T): T?

ifRichTextSpoiler

inline fun <T> RichText.ifRichTextSpoiler(block: (RichTextSpoiler) -> T): T?

ifRichTextStrikethrough

inline fun <T> RichText.ifRichTextStrikethrough(block: (RichTextStrikethrough) -> T): T?

ifRichTextSubscript

inline fun <T> RichText.ifRichTextSubscript(block: (RichTextSubscript) -> T): T?

ifRichTextSuperscript

inline fun <T> RichText.ifRichTextSuperscript(block: (RichTextSuperscript) -> T): T?

ifRichTextTextMention

inline fun <T> RichText.ifRichTextTextMention(block: (RichTextTextMention) -> T): T?

ifRichTextUnderline

inline fun <T> RichText.ifRichTextUnderline(block: (RichTextUnderline) -> T): T?

inline fun <T> RichText.ifRichTextUrl(block: (RichTextUrl) -> T): T?

richTextAnchorLinkOrNull

inline fun RichText.richTextAnchorLinkOrNull(): RichTextAnchorLink?

richTextAnchorLinkOrThrow

inline fun RichText.richTextAnchorLinkOrThrow(): RichTextAnchorLink

richTextAnchorOrNull

inline fun RichText.richTextAnchorOrNull(): RichTextAnchor?

richTextAnchorOrThrow

inline fun RichText.richTextAnchorOrThrow(): RichTextAnchor

richTextBankCardNumberOrNull

inline fun RichText.richTextBankCardNumberOrNull(): RichTextBankCardNumber?

richTextBankCardNumberOrThrow

inline fun RichText.richTextBankCardNumberOrThrow(): RichTextBankCardNumber

richTextBoldOrNull

inline fun RichText.richTextBoldOrNull(): RichTextBold?

richTextBoldOrThrow

inline fun RichText.richTextBoldOrThrow(): RichTextBold

richTextBotCommandOrNull

inline fun RichText.richTextBotCommandOrNull(): RichTextBotCommand?

richTextBotCommandOrThrow

inline fun RichText.richTextBotCommandOrThrow(): RichTextBotCommand

richTextCashtagOrNull

inline fun RichText.richTextCashtagOrNull(): RichTextCashtag?

richTextCashtagOrThrow

inline fun RichText.richTextCashtagOrThrow(): RichTextCashtag

richTextCodeOrNull

inline fun RichText.richTextCodeOrNull(): RichTextCode?

richTextCodeOrThrow

inline fun RichText.richTextCodeOrThrow(): RichTextCode

richTextCustomEmojiOrNull

inline fun RichText.richTextCustomEmojiOrNull(): RichTextCustomEmoji?

richTextCustomEmojiOrThrow

inline fun RichText.richTextCustomEmojiOrThrow(): RichTextCustomEmoji

richTextDateTimeOrNull

inline fun RichText.richTextDateTimeOrNull(): RichTextDateTime?

richTextDateTimeOrThrow

inline fun RichText.richTextDateTimeOrThrow(): RichTextDateTime

richTextEmailAddressOrNull

inline fun RichText.richTextEmailAddressOrNull(): RichTextEmailAddress?

richTextEmailAddressOrThrow

inline fun RichText.richTextEmailAddressOrThrow(): RichTextEmailAddress

richTextEntityOrNull

inline fun RichText.richTextEntityOrNull(): RichTextEntity?

richTextEntityOrThrow

inline fun RichText.richTextEntityOrThrow(): RichTextEntity

richTextGroupOrNull

inline fun RichText.richTextGroupOrNull(): RichTextGroup?

richTextGroupOrThrow

inline fun RichText.richTextGroupOrThrow(): RichTextGroup

richTextHashtagOrNull

inline fun RichText.richTextHashtagOrNull(): RichTextHashtag?

richTextHashtagOrThrow

inline fun RichText.richTextHashtagOrThrow(): RichTextHashtag

richTextItalicOrNull

inline fun RichText.richTextItalicOrNull(): RichTextItalic?

richTextItalicOrThrow

inline fun RichText.richTextItalicOrThrow(): RichTextItalic

richTextMarkedOrNull

inline fun RichText.richTextMarkedOrNull(): RichTextMarked?

richTextMarkedOrThrow

inline fun RichText.richTextMarkedOrThrow(): RichTextMarked

richTextMathematicalExpressionOrNull

inline fun RichText.richTextMathematicalExpressionOrNull(): RichTextMathematicalExpression?

richTextMathematicalExpressionOrThrow

inline fun RichText.richTextMathematicalExpressionOrThrow(): RichTextMathematicalExpression

richTextMentionOrNull

inline fun RichText.richTextMentionOrNull(): RichTextMention?

richTextMentionOrThrow

inline fun RichText.richTextMentionOrThrow(): RichTextMention

richTextPhoneNumberOrNull

inline fun RichText.richTextPhoneNumberOrNull(): RichTextPhoneNumber?

richTextPhoneNumberOrThrow

inline fun RichText.richTextPhoneNumberOrThrow(): RichTextPhoneNumber

richTextPlainOrNull

inline fun RichText.richTextPlainOrNull(): RichTextPlain?

richTextPlainOrThrow

inline fun RichText.richTextPlainOrThrow(): RichTextPlain

richTextReferenceLinkOrNull

inline fun RichText.richTextReferenceLinkOrNull(): RichTextReferenceLink?

richTextReferenceLinkOrThrow

inline fun RichText.richTextReferenceLinkOrThrow(): RichTextReferenceLink

richTextReferenceOrNull

inline fun RichText.richTextReferenceOrNull(): RichTextReference?

richTextReferenceOrThrow

inline fun RichText.richTextReferenceOrThrow(): RichTextReference

richTextSpoilerOrNull

inline fun RichText.richTextSpoilerOrNull(): RichTextSpoiler?

richTextSpoilerOrThrow

inline fun RichText.richTextSpoilerOrThrow(): RichTextSpoiler

richTextStrikethroughOrNull

inline fun RichText.richTextStrikethroughOrNull(): RichTextStrikethrough?

richTextStrikethroughOrThrow

inline fun RichText.richTextStrikethroughOrThrow(): RichTextStrikethrough

richTextSubscriptOrNull

inline fun RichText.richTextSubscriptOrNull(): RichTextSubscript?

richTextSubscriptOrThrow

inline fun RichText.richTextSubscriptOrThrow(): RichTextSubscript

richTextSuperscriptOrNull

inline fun RichText.richTextSuperscriptOrNull(): RichTextSuperscript?

richTextSuperscriptOrThrow

inline fun RichText.richTextSuperscriptOrThrow(): RichTextSuperscript

richTextTextMentionOrNull

inline fun RichText.richTextTextMentionOrNull(): RichTextTextMention?

richTextTextMentionOrThrow

inline fun RichText.richTextTextMentionOrThrow(): RichTextTextMention

richTextUnderlineOrNull

inline fun RichText.richTextUnderlineOrNull(): RichTextUnderline?

richTextUnderlineOrThrow

inline fun RichText.richTextUnderlineOrThrow(): RichTextUnderline

richTextUrlOrNull

inline fun RichText.richTextUrlOrNull(): RichTextUrl?

richTextUrlOrThrow

inline fun RichText.richTextUrlOrThrow(): RichTextUrl