Telegram Bot/eu.vendeli.tgbot.interfaces.features/CaptionFeature

CaptionFeature

interface CaptionFeature<Action : TgAction<*>, CaptionFeature<Action>> : Feature, EntitiesCtxBuilder<Action>

Caption feature, see Features article

Parameters

Action

Action class itself.

Inheritors

SendAnimationAction

SendAudioAction

SendDocumentAction

SendPhotoAction

SendPaidMediaAction

SendVideoAction

SendVoiceAction

CopyMessageAction

EditMessageCaptionAction

Functions

open override fun EntitiesExtBuilder.addEntity(entity: MessageEntity)

open fun EntitiesExtBuilder.blockquote(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.bold(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.botCommand(block: () -> String): Pair<EntityType, String>

open fun caption(block: EntitiesCtxBuilder<Action>.() -> String): Action

DSL for adding captions

captionEntities

open fun captionEntities(block: EntitiesBuilder.() -> Unit): Action

Caption entities DSL with EntitiesBuilder

open fun captionEntities(entities: List<MessageEntity>): Action

Caption entities

open fun EntitiesExtBuilder.cashtag(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.code(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.customEmoji(customEmojiId: String? = null, block: () -> String): Triple<EntityType, String, String?>

open fun EntitiesExtBuilder.email(block: () -> String): Pair<EntityType, String>

expandableBlockquote

open fun EntitiesExtBuilder.expandableBlockquote(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.hashtag(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.italic(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.mention(block: () -> String): Pair<EntityType, String>

open operator fun Pair<EntityType, String>.minus(other: String): String

open operator fun String.minus(other: Pair<EntityType, String>): String

open operator fun String.minus(other: String): String

open operator fun <T> String.minus(other: Triple<EntityType, String, T?>): String

open operator fun <T> Triple<EntityType, String, T?>.minus(other: String): String

open fun EntitiesExtBuilder.phoneNumber(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.pre(language: String? = null, block: () -> String): Triple<EntityType, String, String?>

open fun EntitiesExtBuilder.spoiler(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.strikethrough(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.textLink(url: String? = null, block: () -> String): Triple<EntityType, String, String?>

open fun EntitiesExtBuilder.textMention(user: User? = null, block: () -> String): Triple<EntityType, String, User?>

open fun EntitiesExtBuilder.underline(block: () -> String): Pair<EntityType, String>

open fun EntitiesExtBuilder.url(block: () -> String): Pair<EntityType, String>