simbot-component-telegram-stdlib/love.forte.simbot.telegram.stdlib.bot

Package-level declarations

Types

Link copied to clipboard
interface Bot : CoroutineScope

A Telegram Bot.

Link copied to clipboard
class BotConfiguration

A configuration for Bot.

Link copied to clipboard
object BotFactory

A Bot factory.

Link copied to clipboard
data class LongPolling(val limit: Int? = null, val timeout: Int? = DefaultLongPollingTimeout.inWholeSeconds.toInt(), val allowedUpdates: Collection<String>? = null, val retry: LongPolling.Retry? = null)

Long polled configurations.

Link copied to clipboard

Inherited functions

Link copied to clipboard
inline fun Bot.onCallbackQuery(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, callbackQuery: CallbackQuery) -> Unit)

Register processor for CallbackQuery named CALLBACK_QUERY_NAME

Link copied to clipboard
inline fun Bot.onChannelPost(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, channelPost: Message) -> Unit)

Register processor for Message named CHANNEL_POST_NAME

Link copied to clipboard
inline fun Bot.onChatBoost(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, chatBoost: ChatBoostUpdated) -> Unit)

Register processor for ChatBoostUpdated named CHAT_BOOST_NAME

Link copied to clipboard
inline fun Bot.onChatJoinRequest(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, chatJoinRequest: ChatJoinRequest) -> Unit)

Register processor for ChatJoinRequest named CHAT_JOIN_REQUEST_NAME

Link copied to clipboard
inline fun Bot.onChatMember(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, chatMember: ChatMemberUpdated) -> Unit)

Register processor for ChatMemberUpdated named CHAT_MEMBER_NAME

Link copied to clipboard
inline fun Bot.onChosenInlineResult(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, chosenInlineResult: ChosenInlineResult) -> Unit)

Register processor for ChosenInlineResult named CHOSEN_INLINE_RESULT_NAME

Link copied to clipboard
inline fun Bot.onEditedChannelPost(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, editedChannelPost: Message) -> Unit)

Register processor for Message named EDITED_CHANNEL_POST_NAME

Link copied to clipboard
inline fun Bot.onEditedMessage(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, editedMessage: Message) -> Unit)

Register processor for Message named EDITED_MESSAGE_NAME

Link copied to clipboard
inline fun Bot.onInlineQuery(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, inlineQuery: InlineQuery) -> Unit)

Register processor for InlineQuery named INLINE_QUERY_NAME

Link copied to clipboard
inline fun Bot.onMessage(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, message: Message) -> Unit)

Register processor for Message named MESSAGE_NAME

Link copied to clipboard
inline fun Bot.onMessageReaction(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, messageReaction: MessageReactionUpdated) -> Unit)

Register processor for MessageReactionUpdated named MESSAGE_REACTION_NAME

Link copied to clipboard
inline fun Bot.onMessageReactionCount(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, messageReactionCount: MessageReactionCountUpdated) -> Unit)

Register processor for MessageReactionCountUpdated named MESSAGE_REACTION_COUNT_NAME

Link copied to clipboard
inline fun Bot.onMyChatMember(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, myChatMember: ChatMemberUpdated) -> Unit)

Register processor for ChatMemberUpdated named MY_CHAT_MEMBER_NAME

Link copied to clipboard
inline fun Bot.onPoll(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, poll: Poll) -> Unit)

Register processor for Poll named POLL_NAME

Link copied to clipboard
inline fun Bot.onPollAnswer(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, pollAnswer: PollAnswer) -> Unit)

Register processor for PollAnswer named POLL_ANSWER_NAME

Link copied to clipboard
inline fun Bot.onPreCheckoutQuery(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, preCheckoutQuery: PreCheckoutQuery) -> Unit)

Register processor for PreCheckoutQuery named PRE_CHECKOUT_QUERY_NAME

Link copied to clipboard
inline fun Bot.onRemovedChatBoost(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, removedChatBoost: ChatBoostRemoved) -> Unit)

Register processor for ChatBoostRemoved named REMOVED_CHAT_BOOST_NAME

Link copied to clipboard
inline fun Bot.onShippingQuery(sequence: SubscribeSequence = NORMAL, crossinline processor: suspend (Event, shippingQuery: ShippingQuery) -> Unit)

Register processor for ShippingQuery named SHIPPING_QUERY_NAME

Link copied to clipboard
suspend fun Bot.pushRawUpdate(raw: String)

Push a Update raw JSON string.

Link copied to clipboard
Link copied to clipboard
@JvmOverloads
fun TelegramApi<*>.requestByBlocking(bot: Bot, context: CoroutineContext? = null): HttpResponse

requestRawBy in blocking.

Link copied to clipboard
@JvmOverloads
fun TelegramApi<*>.requestByReserve(bot: Bot, scope: CoroutineScope? = null, context: CoroutineContext? = null): SuspendReserve<HttpResponse>

requestRawBy in blocking.

Link copied to clipboard
suspend fun <R : Any> TelegramApi<R>.requestDataBy(bot: Bot): R

Use bot to request the TelegramApi and get R.

Link copied to clipboard
@JvmOverloads
fun <R : Any> TelegramApi<R>.requestDataByAsync(bot: Bot, scope: CoroutineScope? = null, context: CoroutineContext? = null): CompletableFuture<R>

requestDataBy in async.

Link copied to clipboard
@JvmOverloads
fun <R : Any> TelegramApi<R>.requestDataByBlocking(bot: Bot, context: CoroutineContext? = null): R

requestDataBy in blocking.

Link copied to clipboard
@JvmOverloads
fun <R : Any> TelegramApi<R>.requestDataByReserve(bot: Bot, scope: CoroutineScope? = null, context: CoroutineContext? = null): SuspendReserve<R>

requestDataBy in blocking.

Link copied to clipboard
suspend fun TelegramApi<*>.requestRawBy(bot: Bot): HttpResponse

Use bot to request the TelegramApi and get HttpResponse.

Link copied to clipboard
suspend fun <R : Any> TelegramApi<R>.requestResultBy(bot: Bot): TelegramApiResult<R>

Use bot to request the TelegramApi and get TelegramApiResult with R.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> Bot.subscribe(name: String? = null, sequence: SubscribeSequence = SubscribeSequence.NORMAL, crossinline processor: suspend (Event, T) -> Unit)

Bot.subscribe simplified extension. Matches events based on type T (and optional name).