Telegram Bot/eu.vendeli.tgbot.api.message/SendMessageAction

SendMessageAction

class SendMessageAction : Action<Message> , BusinessActionExt<Message> , OptionsFeature<SendMessageAction, MessageOptions> , MarkupFeature<SendMessageAction> , EntitiesFeature<SendMessageAction> , EntitiesCtxBuilder<SendMessageAction>

Constructors

SendMessageAction

constructor(text: String)

Properties

parameters

@KtGramInternal

open override val Request<Message>.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>

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<Message>.doRequest(bot: TelegramBot)

doRequestReturning

@KtGramInternal

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

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

entities

open fun entities(block: EntitiesBuilder.() -> Unit): SendMessageAction

Entities adding DSL

open fun entities(entities: List<MessageEntity>): SendMessageAction

Add Entities directly

expandableBlockquote

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

forceReply

open fun forceReply(inputFieldPlaceholder: String? = null, selective: Boolean? = null): SendMessageAction

Add ForceReply markup to the TgAction<Return>.

hashtag

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

inlineKeyboardMarkup

open fun inlineKeyboardMarkup(block: InlineKeyboardMarkupBuilder.() -> Unit): SendMessageAction

Add InlineKeyboard markup to the TgAction<Return>.

italic

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

markup

open fun markup(keyboard: Keyboard): SendMessageAction

Add Markup directly.

open fun markup(block: () -> Keyboard): SendMessageAction

Add Markup via lambda.

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: MessageOptions.() -> Unit): SendMessageAction

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?>

replyKeyboardMarkup

open fun replyKeyboardMarkup(block: ReplyKeyboardMarkupBuilder.() -> Unit): SendMessageAction

Add ReplyKeyboard markup to the TgAction<Return>.

replyKeyboardRemove

open fun replyKeyboardRemove(selective: Boolean? = null): SendMessageAction

Add ReplyKeyboardRemove markup to the Action<Return>

send

inline suspend fun send(to: User, via: TelegramBot)

inline suspend fun send(to: Chat, via: TelegramBot)

suspend fun send(to: Long, via: TelegramBot)

suspend fun send(to: String, via: TelegramBot)

Make a request for action.

sendAsync

inline suspend fun sendAsync(to: User, via: TelegramBot): Deferred<Response<out Message>>

inline suspend fun sendAsync(to: Chat, via: TelegramBot): Deferred<Response<out Message>>

suspend fun sendAsync(to: Long, via: TelegramBot): Deferred<Response<out Message>>

suspend fun sendAsync(to: String, via: TelegramBot): Deferred<Response<out Message>>

Make a request for action returning its Response.

sendBusiness

open suspend fun sendBusiness(chatId: Long, businessConnectionId: String, via: TelegramBot)

Make business request for action.

sendBusinessAsync

open suspend fun sendBusinessAsync(chatId: Long, businessConnectionId: String, via: TelegramBot): Deferred<Response<out Message>>

Make a request for action returning its Response.

sendReturning

inline suspend fun sendReturning(to: User, via: TelegramBot): Deferred<Response<out Message>>

inline suspend fun sendReturning(to: Chat, via: TelegramBot): Deferred<Response<out Message>>

inline suspend fun sendReturning(to: Long, via: TelegramBot): Deferred<Response<out Message>>

inline suspend fun sendReturning(to: String, via: TelegramBot): Deferred<Response<out Message>>

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>