telegram-bot/eu.vendeli.tgbot.api.story/PostStoryAction

PostStoryAction

class PostStoryAction(businessConnectionId: String, content: InputStoryContent, activePeriod: Duration) : SimpleAction<Story> , CaptionFeature<PostStoryAction> , OptionsFeature<PostStoryAction, PostStoryOptions> (source)

Constructors

PostStoryAction

constructor(businessConnectionId: String, content: InputStoryContent, activePeriod: Duration)

Properties

methodName

@KtGramInternal

val Request<Story>.methodName: String

parameters

@KtGramInternal

open override val Request<Story>.parameters: MutableMap<String, JsonElement>

Functions

addEntity

open override fun EntitiesExtBuilder.addEntity(entity: MessageEntity)

blockquote

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

bold

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

botCommand

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

caption

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

DSL for adding captions

captionEntities

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

Caption entities DSL with EntitiesBuilder

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

Caption entities

cashtag

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

code

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

customEmoji

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

doRequest

@KtGramInternal

open suspend override fun Request<Story>.doRequest(bot: TelegramBot)

doRequestReturning

@KtGramInternal

open suspend override fun Request<Story>.doRequestReturning(bot: TelegramBot): Deferred<Response<out Story>>

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

expandableBlockquote

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

hashtag

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

italic

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

mention

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

minus

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

options

open fun options(block: PostStoryOptions.() -> Unit): PostStoryAction

Lambda function to change options

phoneNumber

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

pre

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

send

suspend fun send(to: TelegramBot)

Send request for action.

sendReturning

inline suspend fun sendReturning(to: TelegramBot): Deferred<Response<out Story>>

Send request returning its Response.

spoiler

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

strikethrough

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

textLink

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

textMention

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

toWebhookResponse

fun toWebhookResponse(): String

Payload to make response for the webhook request as described there.

underline

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

url

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