docs/dev.inmo.tgbotapi.types.message.textsources

Package dev.inmo.tgbotapi.types.message.textsources

Types

BoldTextSource

data class BoldTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

BotCommandTextSource

data class BotCommandTextSource constructor(val source: String) : TextSource

CashTagTextSource

data class CashTagTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

CodeTextSource

data class CodeTextSource constructor(val source: String) : TextSource

CustomEmojiTextSource

data class CustomEmojiTextSource constructor( val source: String, val customEmojiId: CustomEmojiId, val subsources: TextSourcesList) : MultilevelTextSource

EMailTextSource

data class EMailTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

HashTagTextSource

data class HashTagTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

ItalicTextSource

data class ItalicTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

MentionTextSource

data class MentionTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

MultilevelTextSource

interface MultilevelTextSource : TextSource

MutableTextSourcesList

typealias MutableTextSourcesList = MutableList<TextSource>

PhoneNumberTextSource

data class PhoneNumberTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

PreTextSource

data class PreTextSource constructor(val source: String, val language: String? = null) : TextSource

RegularTextSource

data class RegularTextSource constructor(val source: String) : TextSource

SpoilerTextSource

data class SpoilerTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

StrikethroughTextSource

data class StrikethroughTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

TextLinkTextSource

data class TextLinkTextSource constructor(val source: String, val url: String) : TextSource

TextMentionTextSource

data class TextMentionTextSource constructor( val source: String, val user: User, val subsources: TextSourcesList) : MultilevelTextSource

TextSource

interface TextSource

TextSourceSerializer

object TextSourceSerializer : TypedSerializer<TextSource>

TextSourcesList

typealias TextSourcesList = List<TextSource>

UnderlineTextSource

data class UnderlineTextSource constructor(val source: String, val subsources: TextSourcesList) : MultilevelTextSource

URLTextSource

data class URLTextSource constructor(val source: String) : TextSource

Functions

bold

inline fun bold(vararg parts: TextSource): BoldTextSource

inline fun bold(text: String): BoldTextSource

inline fun bold(parts: TextSourcesList): BoldTextSource

botCommand

inline fun botCommand(command: String): BotCommandTextSource

cashTag

inline fun cashTag(vararg parts: TextSource): CashTagTextSource

inline fun cashTag(tag: String): CashTagTextSource

inline fun cashTag(parts: TextSourcesList): CashTagTextSource

code

inline fun code(code: String): CodeTextSource

customEmoji

inline fun customEmoji(emojiId: CustomEmojiId, vararg parts: TextSource): CustomEmojiTextSource

inline fun customEmoji(emojiId: CustomEmojiId, parts: TextSourcesList): CustomEmojiTextSource

inline fun customEmoji(emojiId: CustomEmojiId, text: String): CustomEmojiTextSource

Without sharp (#)

inline fun email(vararg parts: TextSource): EMailTextSource

inline fun email(emailAddress: String): EMailTextSource

inline fun email(parts: TextSourcesList): EMailTextSource

hashtag

inline fun hashtag(vararg parts: TextSource): HashTagTextSource

inline fun hashtag(parts: TextSourcesList): HashTagTextSource

inline fun hashtag(hashtag: String): HashTagTextSource

Without sharp (#)

italic

inline fun italic(vararg parts: TextSource): ItalicTextSource

inline fun italic(text: String): ItalicTextSource

inline fun italic(parts: TextSourcesList): ItalicTextSource

link

inline fun link(url: String): URLTextSource

inline fun link(text: String, url: String): TextLinkTextSource

mention

inline fun mention(whoToMention: Username): MentionTextSource

inline fun mention(vararg parts: TextSource): MentionTextSource

inline fun mention(parts: TextSourcesList): MentionTextSource

inline fun UserId.mention(text: String): TextMentionTextSource

inline fun UserId.mention(parts: TextSourcesList): TextMentionTextSource

inline fun User.mention(text: String): TextMentionTextSource

inline fun User.mention(parts: TextSourcesList): TextMentionTextSource

inline fun Identifier.mention(text: String): TextMentionTextSource

inline fun Identifier.mention(parts: TextSourcesList): TextMentionTextSource

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

inline fun mention(text: String, userId: UserId): TextMentionTextSource

inline fun mention(text: String, user: User): TextMentionTextSource

inline fun mention(text: String, id: Identifier): TextMentionTextSource

inline fun mention(parts: TextSourcesList, userId: UserId): TextMentionTextSource

inline fun mention(parts: TextSourcesList, user: User): TextMentionTextSource

inline fun mention(parts: TextSourcesList, id: Identifier): TextMentionTextSource

inline fun mention(whoToMention: String): MentionTextSource

Without leading "@"

phone

inline fun phone(vararg parts: TextSource): PhoneNumberTextSource

inline fun phone(number: String): PhoneNumberTextSource

inline fun phone(parts: TextSourcesList): PhoneNumberTextSource

plus

inline operator fun TextSource.plus(other: TextSource): List<TextSource>

inline operator fun TextSource.plus(text: String): List<TextSource>

inline operator fun TextSource.plus(other: List<TextSource>): List<TextSource>

inline operator fun List<TextSource>.plus(text: String): List<TextSource>

pre

inline fun pre(code: String, language: String? = null): PreTextSource

regular

inline fun regular(text: String): RegularTextSource

regularln

inline fun regularln(text: String): RegularTextSource

separateForCaption

fun List<TextSource>.separateForCaption(): List<List<TextSource>>

This method will prepare TextSources list for messages. Remember, that first part will be separated with captionLength and all others with

separateForMessage

fun List<TextSource>.separateForMessage(limit: IntRange, numberOfParts: Int? = null): List<List<TextSource>>

separateForText

inline fun List<TextSource>.separateForText(): List<List<TextSource>>

This method will prepare TextSources list for messages with textLength

splitForCaption

fun List<TextSource>.splitForCaption(): List<List<TextSource>>

This method will prepare TextSources list for messages. Remember, that first part will be separated with captionLength and all others with

splitForMessage

fun List<TextSource>.splitForMessage(limit: IntRange, numberOfParts: Int? = null): List<List<TextSource>>

splitForText

inline fun List<TextSource>.splitForText(): List<List<TextSource>>

This method will prepare TextSources list for messages with textLength

spoiler

inline fun spoiler(vararg parts: TextSource): SpoilerTextSource

inline fun spoiler(text: String): SpoilerTextSource

inline fun spoiler(parts: TextSourcesList): SpoilerTextSource

strikethrough

inline fun strikethrough(vararg parts: TextSource): StrikethroughTextSource

inline fun strikethrough(text: String): StrikethroughTextSource

inline fun strikethrough(parts: TextSourcesList): StrikethroughTextSource

textSourcesOrElse

inline fun textSourcesOrElse(textSources: TextSourcesList, block: () -> TextSourcesList): TextSourcesList

textSourcesOrElseTextSource

inline fun textSourcesOrElseTextSource(textSources: TextSourcesList, block: () -> TextSource): TextSourcesList

underline

inline fun underline(vararg parts: TextSource): UnderlineTextSource

inline fun underline(text: String): UnderlineTextSource

inline fun underline(parts: TextSourcesList): UnderlineTextSource

Properties

DirectInvocationOfTextSourceConstructor

const val DirectInvocationOfTextSourceConstructor: String