docs

# EntitiesBuilder

class EntitiesBuilder
Content copied to clipboard

This builder can be used to provide building of TextSources List

## See also

buildEntities

## Functions

add
Link copied to clipboard
fun add (source: TextSource ): EntitiesBuilder
Content copied to clipboard
addAll
Link copied to clipboard
fun addAll (sources: Iterable < TextSource >): EntitiesBuilder
Content copied to clipboard
build
Link copied to clipboard
fun build (): TextSourcesList
Content copied to clipboard
invoke
Link copied to clipboard
operator fun invoke (vararg source: TextSource ): EntitiesBuilder
Content copied to clipboard
plus
Link copied to clipboard
operator fun plus (other: EntitiesBuilder ): EntitiesBuilder
Content copied to clipboard
operator fun plus (source: TextSource ): EntitiesBuilder
Content copied to clipboard
operator fun plus (text: String ): EntitiesBuilder
Content copied to clipboard
operator fun plus (sources: Iterable < TextSource >): EntitiesBuilder
Content copied to clipboard
unaryPlus
Link copied to clipboard
operator fun TextSource . unaryPlus (): EntitiesBuilder
Content copied to clipboard
operator fun String . unaryPlus (): EntitiesBuilder
Content copied to clipboard
operator fun TextSourcesList . unaryPlus (): EntitiesBuilder
Content copied to clipboard

## Properties

entities
Link copied to clipboard
val entities : TextSourcesList
Content copied to clipboard

It is not safe field which contains potentially changeable List

separator
Link copied to clipboard
val separator : TextSource ? = null
Content copied to clipboard

## Extensions

bold
Link copied to clipboard
inline fun EntitiesBuilder . bold (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . bold (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . bold (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . bold (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

boldln
Link copied to clipboard
inline fun EntitiesBuilder . boldln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . boldln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . boldln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.bold with new line at the end

inline fun EntitiesBuilder . boldln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

botCommand
Link copied to clipboard
inline fun EntitiesBuilder . botCommand (command: String ): EntitiesBuilder
Content copied to clipboard

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

botCommandln
Link copied to clipboard
inline fun EntitiesBuilder . botCommandln (command: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.botCommand with new line at the end

cashTag
Link copied to clipboard
inline fun EntitiesBuilder . cashTag (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . cashTag (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . cashTag (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . cashTag (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

cashTagln
Link copied to clipboard
inline fun EntitiesBuilder . cashTagln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . cashTagln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . cashTagln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.cashTag with new line at the end

inline fun EntitiesBuilder . cashTagln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

code
Link copied to clipboard
inline fun EntitiesBuilder . code (code: String ): EntitiesBuilder
Content copied to clipboard

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

codeln
Link copied to clipboard
inline fun EntitiesBuilder . codeln (code: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.code with new line at the end

email
Link copied to clipboard
inline fun EntitiesBuilder . email (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . email (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . email (emailAddress: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . email (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

emailln
Link copied to clipboard
inline fun EntitiesBuilder . emailln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . emailln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . emailln (emailAddress: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.email with new line at the end

inline fun EntitiesBuilder . emailln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

hashtag
Link copied to clipboard
inline fun EntitiesBuilder . hashtag (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . hashtag (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . hashtag (hashtag: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . hashtag (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

hashtagln
Link copied to clipboard
inline fun EntitiesBuilder . hashtagln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . hashtagln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . hashtagln (hashtag: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.hashtag with new line at the end

inline fun EntitiesBuilder . hashtagln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

italic
Link copied to clipboard
inline fun EntitiesBuilder . italic (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . italic (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . italic (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . italic (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

italicln
Link copied to clipboard
inline fun EntitiesBuilder . italicln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . italicln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . italicln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.italic with new line at the end

inline fun EntitiesBuilder . italicln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

link
Link copied to clipboard
inline fun EntitiesBuilder . link (text: String , url: String ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . link (url: String ): EntitiesBuilder
Content copied to clipboard

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

linkln
Link copied to clipboard
inline fun EntitiesBuilder . linkln (text: String , url: String ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . linkln (url: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.link with new line at the end

mention
Link copied to clipboard
inline fun EntitiesBuilder . mention (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mention (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mention (whoToMention: String ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mention (parts: TextSourcesList , user: User ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mention (text: String , user: User ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . mention (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . mention (user: User , vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
mentionln
Link copied to clipboard
inline fun EntitiesBuilder . mentionln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mentionln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mentionln (whoToMention: String ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mentionln (parts: TextSourcesList , user: User ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mentionln (user: User , vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . mentionln (text: String , user: User ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.mention with new line at the end

inline fun EntitiesBuilder . mentionln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

phone
Link copied to clipboard
inline fun EntitiesBuilder . phone (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . phone (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . phone (number: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . phone (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

phoneln
Link copied to clipboard
inline fun EntitiesBuilder . phoneln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . phoneln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . phoneln (number: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.phone with new line at the end

inline fun EntitiesBuilder . phoneln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

pre
Link copied to clipboard
inline fun EntitiesBuilder . pre (code: String , language: String ?): EntitiesBuilder
Content copied to clipboard

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

preln
Link copied to clipboard
inline fun EntitiesBuilder . preln (code: String , language: String ?): List < TextSource >
Content copied to clipboard

Version of EntitiesBuilder.pre with new line at the end

regular
Link copied to clipboard
inline fun EntitiesBuilder . regular (text: String ): EntitiesBuilder
Content copied to clipboard

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

regularln
Link copied to clipboard
inline fun EntitiesBuilder . regularln (text: String ): EntitiesBuilder
Content copied to clipboard

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

spoiler
Link copied to clipboard
inline fun EntitiesBuilder . spoiler (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . spoiler (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . spoiler (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . spoiler (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

spoilerln
Link copied to clipboard
inline fun EntitiesBuilder . spoilerln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . spoilerln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . spoilerln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.spoiler with new line at the end

inline fun EntitiesBuilder . spoilerln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

strikethrough
Link copied to clipboard
inline fun EntitiesBuilder . strikethrough (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . strikethrough (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . strikethrough (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . strikethrough (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

strikethroughln
Link copied to clipboard
inline fun EntitiesBuilder . strikethroughln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . strikethroughln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . strikethroughln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.strikethrough with new line at the end

inline fun EntitiesBuilder . strikethroughln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

underline
Link copied to clipboard
inline fun EntitiesBuilder . underline (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . underline (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . underline (text: String ): EntitiesBuilder
Content copied to clipboard

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

inline fun EntitiesBuilder . underline (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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

underlineln
Link copied to clipboard
inline fun EntitiesBuilder . underlineln (parts: TextSourcesList ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . underlineln (vararg parts: TextSource ): EntitiesBuilder
Content copied to clipboard
inline fun EntitiesBuilder . underlineln (text: String ): EntitiesBuilder
Content copied to clipboard

Version of EntitiesBuilder.underline with new line at the end

inline fun EntitiesBuilder . underlineln (noinline init: EntitiesBuilderBody ): EntitiesBuilder
Content copied to clipboard

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