1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-19 14:53:48 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.extensions.utils.formatting/-entities-builder/index.md

59 lines
17 KiB
Markdown
Raw Normal View History

//[docs](../../../index.md)/[dev.inmo.tgbotapi.extensions.utils.formatting](../index.md)/[EntitiesBuilder](index.md)
# EntitiesBuilder
[common] class [EntitiesBuilder](index.md)
This builder can be used to provide building of [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)s [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)
## See also
common
| | |
|---|---|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder///PointingToDeclaration/"></a>[buildEntities](../build-entities.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder///PointingToDeclaration/"></a>|
## Functions
| Name | Summary |
|---|---|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/add/#dev.inmo.tgbotapi.CommonAbstracts.TextSource/PointingToDeclaration/"></a>[add](add.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/add/#dev.inmo.tgbotapi.CommonAbstracts.TextSource/PointingToDeclaration/"></a>[common] <br>Content <br>fun [add](add.md)(source: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/build/#/PointingToDeclaration/"></a>[build](build.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/build/#/PointingToDeclaration/"></a>[common] <br>Content <br>fun [build](build.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)> <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/invoke/#kotlin.Array[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[invoke](invoke.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/invoke/#kotlin.Array[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>operator fun [invoke](invoke.md)(vararg source: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/unaryPlus/dev.inmo.tgbotapi.CommonAbstracts.TextSource#/PointingToDeclaration/"></a>[unaryPlus](unary-plus.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/unaryPlus/dev.inmo.tgbotapi.CommonAbstracts.TextSource#/PointingToDeclaration/"></a>[common] <br>Content <br>operator fun [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md).[unaryPlus](unary-plus.md)() <br>operator fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html).[unaryPlus](unary-plus.md)() <br>operator fun [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>.[unaryPlus](unary-plus.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) <br><br><br>|
## Properties
| Name | Summary |
|---|---|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/entities/#/PointingToDeclaration/"></a>[entities](entities.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting/EntitiesBuilder/entities/#/PointingToDeclaration/"></a> [common] val [entities](entities.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>It is not safe field which contains potentially changeable [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html) <br>|
## Extensions
| Name | Summary |
|---|---|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//bold/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[bold](../bold.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//bold/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[bold](../bold.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[bold](../bold.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[bold](../bold.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//botCommand/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[botCommand](../bot-command.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//botCommand/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[botCommand](../bot-command.md)(command: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//cashTag/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[cashTag](../cash-tag.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//cashTag/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[cashTag](../cash-tag.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[cashTag](../cash-tag.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[cashTag](../cash-tag.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//code/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[code](../code.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//code/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[code](../code.md)(code: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//email/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[email](../email.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//email/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[email](../email.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[email](../email.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[email](../email.md)(emailAddress: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//hashtag/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[hashtag](../hashtag.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//hashtag/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[hashtag](../hashtag.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[hashtag](../hashtag.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[hashtag](../hashtag.md)(hashtag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//italic/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[italic](../italic.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//italic/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[italic](../italic.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[italic](../italic.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[italic](../italic.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//link/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String#kotlin.String/PointingToDeclaration/"></a>[link](../link.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//link/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String#kotlin.String/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[link](../link.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br>inline fun [EntitiesBuilder](index.md).[link](../link.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//mention/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[mention](../mention.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//mention/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(whoToMention: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>, user: [User](../../dev.inmo.tgbotapi.types/-user/index.md)) <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(user: [User](../../dev.inmo.tgbotapi.types/-user/index.md), vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[mention](../mention.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), user: [User](../../dev.inmo.tgbotapi.types/-user/index.md)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//phone/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[phone](../phone.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//phone/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[phone](../phone.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[phone](../phone.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[phone](../phone.md)(number: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//pre/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String#kotlin.String?/PointingToDeclaration/"></a>[pre](../pre.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//pre/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String#kotlin.String?/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[pre](../pre.md)(code: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), language: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//regular/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[regular](../regular.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//regular/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.String/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[regular](../regular.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//strikethrough/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[strikethrough](../strikethrough.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//strikethrough/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[strikethrough](../strikethrough.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[strikethrough](../strikethrough.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[strikethrough](../strikethrough.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|
| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//underline/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[underline](../underline.md)| <a name="dev.inmo.tgbotapi.extensions.utils.formatting//underline/dev.inmo.tgbotapi.extensions.utils.formatting.EntitiesBuilder#kotlin.collections.List[dev.inmo.tgbotapi.CommonAbstracts.TextSource]/PointingToDeclaration/"></a>[common] <br>Content <br>inline fun [EntitiesBuilder](index.md).[underline](../underline.md)(parts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)>) <br>inline fun [EntitiesBuilder](index.md).[underline](../underline.md)(vararg parts: [TextSource](../../dev.inmo.tgbotapi.CommonAbstracts/-text-source/index.md)) <br>inline fun [EntitiesBuilder](index.md).[underline](../underline.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) <br><br><br>|