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

RichTextBuilder

Builder of a single RichText. Each call appends a part; build returns a RichTextPlain/RichTextEntity when there is exactly one part, a RichTextGroup otherwise.

Constructors

RichTextBuilder

constructor()

Functions

add

fun add(richText: RichText)

Appends an already built RichText.

anchor

fun anchor(name: String)

anchorLink

fun anchorLink(anchorName: String, block: RichTextBuilder.() -> Unit)

fun anchorLink(text: String, anchorName: String)

bankCard

fun bankCard(bankCardNumber: String, block: RichTextBuilder.() -> Unit)

fun bankCard(text: String, bankCardNumber: String)

bold

fun bold(block: RichTextBuilder.() -> Unit)

fun bold(text: String)

botCommand

fun botCommand(botCommand: String, block: RichTextBuilder.() -> Unit)

fun botCommand(text: String, botCommand: String)

build

fun build(): RichText

button

fun button(button: RichMessageButton)

cashtag

fun cashtag(cashtag: String, block: RichTextBuilder.() -> Unit)

fun cashtag(text: String, cashtag: String)

code

fun code(block: RichTextBuilder.() -> Unit)

fun code(text: String)

customEmoji

fun customEmoji(customEmojiId: CustomEmojiId, alternativeText: String)

dateTime

fun dateTime(unixTime: TelegramDate, dateTimeFormat: DateTimeEntityFormatting, block: RichTextBuilder.() -> Unit)

Appends a nested RichTextDateTime configured by DateTimeEntityFormatting.

fun dateTime(text: String, unixTime: TelegramDate, dateTimeFormat: DateTimeEntityFormatting)

Appends a RichTextDateTime configured by DateTimeEntityFormatting.

fun email(emailAddress: String, block: RichTextBuilder.() -> Unit)

fun email(text: String, emailAddress: String)

hashtag

fun hashtag(hashtag: String, block: RichTextBuilder.() -> Unit)

fun hashtag(text: String, hashtag: String)

italic

fun italic(block: RichTextBuilder.() -> Unit)

fun italic(text: String)

marked

fun marked(block: RichTextBuilder.() -> Unit)

fun marked(text: String)

mathematicalExpression

fun mathematicalExpression(expression: String)

mention

fun mention(username: String, block: RichTextBuilder.() -> Unit)

fun mention(text: String, username: String)

phone

fun phone(phoneNumber: String, block: RichTextBuilder.() -> Unit)

fun phone(text: String, phoneNumber: String)

plain

fun plain(text: String)

Plain, non-formatted text.

reference

fun reference(name: String, block: RichTextBuilder.() -> Unit)

fun reference(text: String, name: String)

referenceLink

fun referenceLink(referenceName: String, block: RichTextBuilder.() -> Unit)

fun referenceLink(text: String, referenceName: String)

spoiler

fun spoiler(block: RichTextBuilder.() -> Unit)

fun spoiler(text: String)

strikethrough

fun strikethrough(block: RichTextBuilder.() -> Unit)

fun strikethrough(text: String)

subscript

fun subscript(block: RichTextBuilder.() -> Unit)

fun subscript(text: String)

superscript

fun superscript(block: RichTextBuilder.() -> Unit)

fun superscript(text: String)

textMention

fun textMention(user: User, block: RichTextBuilder.() -> Unit)

fun textMention(text: String, user: User)

unaryPlus

operator fun RichText.unaryPlus()

Appends an already built RichText.

underline

fun underline(block: RichTextBuilder.() -> Unit)

fun underline(text: String)

url

fun url(url: String, block: RichTextBuilder.() -> Unit)

fun url(text: String, url: String)