Link which can be used as by any user to get access to Message. Returns null in case when there are no known way to build link (for PrivateChats, for example)

makeUsernameLink

common

fun makeUsernameLink(username: String): String

mention

common

inline fun EntitiesBuilder.mention(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.mention(whoToMention: String): EntitiesBuilder

inline fun EntitiesBuilder.mention(parts: TextSourcesList): EntitiesBuilder

inline fun EntitiesBuilder.mention(text: String, user: User): EntitiesBuilder

inline fun EntitiesBuilder.mention(parts: TextSourcesList, user: User): EntitiesBuilder

Add mention using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.mention

inline fun EntitiesBuilder.mention(noinline init: EntitiesBuilderBody): EntitiesBuilder

Add mention using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.mention. Will reuse separator config from buildEntities

infix fun Pair<String, ChatId>.mention(parseMode: ParseMode): String

infix fun String.mention(parseMode: ParseMode): String

inline fun EntitiesBuilder.mention(user: User, vararg parts: TextSource): EntitiesBuilder

mentionHTML

common

fun String.mentionHTML(): String

mentionln

common

inline fun EntitiesBuilder.mentionln(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.mentionln(whoToMention: String): EntitiesBuilder

inline fun EntitiesBuilder.mentionln(parts: TextSourcesList): EntitiesBuilder

inline fun EntitiesBuilder.mentionln(user: User, vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.mentionln(text: String, user: User): EntitiesBuilder

inline fun EntitiesBuilder.mentionln(parts: TextSourcesList, user: User): EntitiesBuilder

Version of EntitiesBuilder.mention with new line at the end

inline fun EntitiesBuilder.mentionln(noinline init: EntitiesBuilderBody): EntitiesBuilder

Version of EntitiesBuilder.mention with new line at the end. Will reuse separator config from buildEntities

mentionMarkdown

common

fun String.mentionMarkdown(): String

mentionMarkdownV2

common

fun String.mentionMarkdownV2(): String

phone

common

inline fun EntitiesBuilder.phone(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.phone(number: String): EntitiesBuilder

inline fun EntitiesBuilder.phone(parts: TextSourcesList): EntitiesBuilder

Add phone using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.phone

inline fun EntitiesBuilder.phone(noinline init: EntitiesBuilderBody): EntitiesBuilder

Add phone using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.phone. Will reuse separator config from buildEntities

infix fun String.phone(parseMode: ParseMode): String

phoneHTML

common

fun String.phoneHTML(): String

phoneln

common

inline fun EntitiesBuilder.phoneln(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.phoneln(number: String): EntitiesBuilder

inline fun EntitiesBuilder.phoneln(parts: TextSourcesList): EntitiesBuilder

Version of EntitiesBuilder.phone with new line at the end

inline fun EntitiesBuilder.phoneln(noinline init: EntitiesBuilderBody): EntitiesBuilder

Version of EntitiesBuilder.phone with new line at the end. Will reuse separator config from buildEntities

phoneMarkdown

common

fun String.phoneMarkdown(): String

phoneMarkdownV2

common

fun String.phoneMarkdownV2(): String

pre

common

infix fun String.pre(parseMode: ParseMode): String

fun String.pre(parseMode: ParseMode, language: String? = null): String

inline fun EntitiesBuilder.pre(code: String, language: String?): EntitiesBuilder

Add pre using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.pre

preHTML

common

fun String.preHTML(language: String? = null): String

preln

common

inline fun EntitiesBuilder.preln(code: String, language: String?): List<TextSource>

Version of EntitiesBuilder.pre with new line at the end

preMarkdown

common

fun String.preMarkdown(language: String? = null): String

preMarkdownV2

common

fun String.preMarkdownV2(language: String? = null): String

regular

common

inline fun EntitiesBuilder.regular(text: String): EntitiesBuilder

Will add simple dev.inmo.tgbotapi.types.MessageEntity.textsources.regular

infix fun String.regular(parseMode: ParseMode): String

regularHtml

common

fun String.regularHtml(): String

regularln

common

inline fun EntitiesBuilder.regularln(text: String): EntitiesBuilder

Will add simple dev.inmo.tgbotapi.types.MessageEntity.textsources.regular and "\n" at the end

regularMarkdown

common

fun String.regularMarkdown(): String

regularMarkdownV2

common

fun String.regularMarkdownV2(): String

strikethrough

common

inline fun EntitiesBuilder.strikethrough(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.strikethrough(text: String): EntitiesBuilder

inline fun EntitiesBuilder.strikethrough(parts: TextSourcesList): EntitiesBuilder

Add strikethrough using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.strikethrough

inline fun EntitiesBuilder.strikethrough(noinline init: EntitiesBuilderBody): EntitiesBuilder

Add strikethrough using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.strikethrough. Will reuse separator config from buildEntities

infix fun String.strikethrough(parseMode: ParseMode): String

strikethroughHTML

common

fun String.strikethroughHTML(): String

strikethroughln

common

inline fun EntitiesBuilder.strikethroughln(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.strikethroughln(text: String): EntitiesBuilder

inline fun EntitiesBuilder.strikethroughln(parts: TextSourcesList): EntitiesBuilder

Version of EntitiesBuilder.strikethrough with new line at the end

inline fun EntitiesBuilder.strikethroughln(noinline init: EntitiesBuilderBody): EntitiesBuilder

Version of EntitiesBuilder.strikethrough with new line at the end. Will reuse separator config from buildEntities

strikethroughMarkdown

common

fun String.strikethroughMarkdown(): String

Crutch for support of strikethrough in default markdown. Simply add modifier, but it will not look like correct

strikethroughMarkdownV2

common

fun String.strikethroughMarkdownV2(): String

textMentionHTML

common

fun String.textMentionHTML(userId: UserId): String

textMentionMarkdown

common

fun String.textMentionMarkdown(userId: UserId): String

textMentionMarkdownV2

common

fun String.textMentionMarkdownV2(userId: UserId): String

toHtmlCaptions

common

fun TextSourcesList.toHtmlCaptions(): List<String>

toHtmlExplanations

common

fun TextSourcesList.toHtmlExplanations(): List<String>

toHtmlTexts

common

fun TextContent.toHtmlTexts(): List<String>

fun TextSourcesList.toHtmlTexts(): List<String>

toMarkdownCaptions

common

fun TextSourcesList.toMarkdownCaptions(): List<String>

toMarkdownExplanations

common

fun TextSourcesList.toMarkdownExplanations(): List<String>

toMarkdownTexts

common

fun TextContent.toMarkdownTexts(): List<String>

fun TextSourcesList.toMarkdownTexts(): List<String>

toMarkdownV2Captions

common

fun TextSourcesList.toMarkdownV2Captions(): List<String>

toMarkdownV2Explanations

common

fun TextSourcesList.toMarkdownV2Explanations(): List<String>

toMarkdownV2Texts

common

fun TextContent.toMarkdownV2Texts(): List<String>

fun TextSourcesList.toMarkdownV2Texts(): List<String>

underline

common

inline fun EntitiesBuilder.underline(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.underline(text: String): EntitiesBuilder

inline fun EntitiesBuilder.underline(parts: TextSourcesList): EntitiesBuilder

Add underline using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.underline

inline fun EntitiesBuilder.underline(noinline init: EntitiesBuilderBody): EntitiesBuilder

Add underline using EntitiesBuilder.add with dev.inmo.tgbotapi.types.MessageEntity.textsources.underline. Will reuse separator config from buildEntities

infix fun String.underline(parseMode: ParseMode): String

underlineHTML

common

fun String.underlineHTML(): String

underlineln

common

inline fun EntitiesBuilder.underlineln(vararg parts: TextSource): EntitiesBuilder

inline fun EntitiesBuilder.underlineln(text: String): EntitiesBuilder

inline fun EntitiesBuilder.underlineln(parts: TextSourcesList): EntitiesBuilder

Version of EntitiesBuilder.underline with new line at the end

inline fun EntitiesBuilder.underlineln(noinline init: EntitiesBuilderBody): EntitiesBuilder

Version of EntitiesBuilder.underline with new line at the end. Will reuse separator config from buildEntities

underlineMarkdown

common

fun String.underlineMarkdown(): String

Crutch for support of underline in default markdown. Simply add modifier, but it will not look like correct

underlineMarkdownV2

common

fun String.underlineMarkdownV2(): String

Properties

htmlBoldControl

common

const val htmlBoldControl: String

htmlCodeControl

common

const val htmlCodeControl: String

htmlItalicControl

common

const val htmlItalicControl: String

htmlPreControl

common

const val htmlPreControl: String

htmlStrikethroughControl

common

const val htmlStrikethroughControl: String

htmlUnderlineControl

common

const val htmlUnderlineControl: String

link

common

val Username.link: String

link

common

val Message.link: String?

link

common

val Chat.link: String?

Link which can be used as by any user to get access to Chat. Returns null in case when there are no known way to build link

markdownBoldControl

common

const val markdownBoldControl: String

markdownCodeControl

common

const val markdownCodeControl: String

markdownItalicControl

common

const val markdownItalicControl: String

markdownPreControl

common

const val markdownPreControl: String

markdownV2ItalicEndControl

common

const val markdownV2ItalicEndControl: String

markdownV2ItalicUnderlineDelimiter

common

const val markdownV2ItalicUnderlineDelimiter: String

markdownV2StrikethroughControl

common

const val markdownV2StrikethroughControl: String

markdownV2UnderlineControl

common

const val markdownV2UnderlineControl: String

markdownV2UnderlineEndControl

common

const val markdownV2UnderlineEndControl: String

newLine

common

val newLine: RegularTextSource

stickerSetLink

common

val StickerSetName.stickerSetLink: TextLinkTextSource