Package dev.inmo.tgbotapi.extensions.utils.formatting

Types

EntitiesBuilder

common

class EntitiesBuilder

This builder can be used to provide building of TextSources List

EntitiesBuilderBody

common

typealias EntitiesBuilderBody = EntitiesBuilder.() -> Unit

Functions

bold

common

inline fun EntitiesBuilder.bold(vararg parts: TextSource)

inline fun EntitiesBuilder.bold(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.bold(text: String)

inline fun EntitiesBuilder.bold(parts: TextSourcesList)

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

boldHTML

common

fun String.boldHTML(): String

boldMarkdown

common

fun String.boldMarkdown(): String

boldMarkdownV2

common

fun String.boldMarkdownV2(): String

botCommand

common

inline fun EntitiesBuilder.botCommand(command: String)

buildEntities

common

fun buildEntities(init: EntitiesBuilderBody): TextSourcesList

cashTag

common

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

cashTagHtml

common

fun String.cashTagHtml(): String

cashTagMarkdown

common

fun String.cashTagMarkdown(): String

cashTagMarkdownV2

common

fun String.cashTagMarkdownV2(): String

code

common

inline fun EntitiesBuilder.code(code: String)

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

codeHTML

common

fun String.codeHTML(): String

codeMarkdown

common

fun String.codeMarkdown(): String

codeMarkdownV2

common

fun String.codeMarkdownV2(): String

command

common

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

fun String.command(adapt: String.() -> String): String

commandHTML

common

fun String.commandHTML(): String

commandMarkdown

common

fun String.commandMarkdown(): String

commandMarkdownV2

common

fun String.commandMarkdownV2(): String

createFormattedText

common

fun createFormattedText(entities: TextSourcesList, partLength: Int = textLength.last, mode: ParseMode = defaultParseMode): List<String>

createHtmlText

common

fun createHtmlText(entities: TextSourcesList, partLength: Int = textLength.last): List<String>

createMarkdownText

common

fun createMarkdownText(entities: TextSourcesList, partLength: Int = textLength.last): List<String>

createMarkdownV2Text

common

fun createMarkdownV2Text(entities: TextSourcesList, partLength: Int = textLength.last): List<String>

common

inline fun EntitiesBuilder.email(vararg parts: TextSource)

inline fun EntitiesBuilder.email(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.email(emailAddress: String)

inline fun EntitiesBuilder.email(parts: TextSourcesList)

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

emailHTML

common

fun String.emailHTML(): String

emailMarkdown

common

fun String.emailMarkdown(): String

emailMarkdownV2

common

fun String.emailMarkdownV2(): String

hashTag

common

inline fun EntitiesBuilder.hashtag(vararg parts: TextSource)

inline fun EntitiesBuilder.hashtag(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.hashtag(hashtag: String)

inline fun EntitiesBuilder.hashtag(parts: TextSourcesList)

hashTagHTML

common

fun String.hashTagHTML(): String

hashTagMarkdown

common

fun String.hashTagMarkdown(): String

hashTagMarkdownV2

common

fun String.hashTagMarkdownV2(): String

italic

common

inline fun EntitiesBuilder.italic(vararg parts: TextSource)

inline fun EntitiesBuilder.italic(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.italic(text: String)

inline fun EntitiesBuilder.italic(parts: TextSourcesList)

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

italicHTML

common

fun String.italicHTML(): String

italicMarkdown

common

fun String.italicMarkdown(): String

italicMarkdownV2

common

fun String.italicMarkdownV2(): String

link

common

inline fun EntitiesBuilder.link(url: String)

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

inline fun EntitiesBuilder.link(text: String, url: String)

linkHTML

common

fun String.linkHTML(link: String): String

linkMarkdown

common

fun String.linkMarkdown(link: String): String

linkMarkdownV2

common

fun String.linkMarkdownV2(link: String): String

makeLink

common

inline fun makeLink(username: Username): String

makeLinkToMessage

common

fun makeLinkToMessage(username: Username, messageId: MessageIdentifier): String

fun makeLinkToMessage(chat: UsernameChat, messageId: MessageIdentifier): String?

fun makeLinkToMessage(username: String, messageId: MessageIdentifier): String

fun makeLinkToMessage(chat: Chat, messageId: MessageIdentifier): String?

Link which can be used as by any user to get access to Message.

makeUsernameLink

common

fun makeUsernameLink(username: String): String

mention

common

inline fun EntitiesBuilder.mention(vararg parts: TextSource)

inline fun EntitiesBuilder.mention(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.mention(whoToMention: String)

inline fun EntitiesBuilder.mention(parts: TextSourcesList)

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)

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

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

mentionHTML

common

fun String.mentionHTML(): String

mentionMarkdown

common

fun String.mentionMarkdown(): String

mentionMarkdownV2

common

fun String.mentionMarkdownV2(): String

phone

common

inline fun EntitiesBuilder.phone(vararg parts: TextSource)

inline fun EntitiesBuilder.phone(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.phone(number: String)

inline fun EntitiesBuilder.phone(parts: TextSourcesList)

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

phoneHTML

common

fun String.phoneHTML(): String

phoneMarkdown

common

fun String.phoneMarkdown(): String

phoneMarkdownV2

common

fun String.phoneMarkdownV2(): String

pre

common

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

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

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

preHTML

common

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

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)

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

regularHtml

common

fun String.regularHtml(): String

regularMarkdown

common

fun String.regularMarkdown(): String

regularMarkdownV2

common

fun String.regularMarkdownV2(): String

strikethrough

common

inline fun EntitiesBuilder.strikethrough(vararg parts: TextSource)

inline fun EntitiesBuilder.strikethrough(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.strikethrough(text: String)

inline fun EntitiesBuilder.strikethrough(parts: TextSourcesList)

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

strikethroughHTML

common

fun String.strikethroughHTML(): String

strikethroughMarkdown

common

fun String.strikethroughMarkdown(): String

Crutch for support of strikethrough in default markdown.

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)

inline fun EntitiesBuilder.underline(noinline init: EntitiesBuilderBody)

inline fun EntitiesBuilder.underline(text: String)

inline fun EntitiesBuilder.underline(parts: TextSourcesList)

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

underlineHTML

common

fun String.underlineHTML(): String

underlineMarkdown

common

fun String.underlineMarkdown(): String

Crutch for support of underline in default markdown.

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.

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

stickerSetLink

common

val StickerSetName.stickerSetLink: TextLinkTextSource