Telegram Bot/eu.vendeli.tgbot.core/FunctionalHandlingDsl

FunctionalHandlingDsl

DSL for functional update management.

Functions

fun SingleInputChain.andThen(rateLimits: RateLimits = RateLimits.NOT_LIMITED, guard: Guard = DefaultGuard, block: OnInputActivity): SingleInputChain

Adding a chain to the input data processing

breakIf

fun SingleInputChain.breakIf(condition: ActivityCtx<ProcessedUpdate>.() -> Boolean, repeat: Boolean = true, block: OnInputActivity? = null): SingleInputChain

Condition, which will cause the chain to be interrupted if it matches.

common

fun common(value: String, filter: KClass<out Filter> = DefaultFilter::class, scope: Set<UpdateType> = DEFAULT_SCOPE, rateLimits: RateLimits = RateLimits.NOT_LIMITED, argParser: KClass<out ArgumentParser> = DefaultArgParser::class, block: OnCommandActivity)

fun common(value: Regex, filter: KClass<out Filter> = DefaultFilter::class, scope: Set<UpdateType> = DEFAULT_SCOPE, rateLimits: RateLimits = RateLimits.NOT_LIMITED, argParser: KClass<out ArgumentParser> = DefaultArgParser::class, block: OnCommandActivity)

Common action that will be checked after other activities.

inputChain

fun inputChain(identifier: String, rateLimits: RateLimits = RateLimits.NOT_LIMITED, guard: Guard = DefaultGuard, block: OnInputActivity): SingleInputChain

Dsl for creating a chain of input processing

onBusinessConnection

fun FunctionalHandlingDsl.onBusinessConnection(block: suspend ActivityCtx<BusinessConnectionUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.businessConnection in the eu.vendeli.tgbot.types.Update.

onBusinessMessage

fun FunctionalHandlingDsl.onBusinessMessage(block: suspend ActivityCtx<BusinessMessageUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.businessMessage in the eu.vendeli.tgbot.types.Update.

onCallbackQuery

fun FunctionalHandlingDsl.onCallbackQuery(block: suspend ActivityCtx<CallbackQueryUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.callbackQuery in the eu.vendeli.tgbot.types.Update.

onChannelPost

fun FunctionalHandlingDsl.onChannelPost(block: suspend ActivityCtx<ChannelPostUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.channelPost in the eu.vendeli.tgbot.types.Update.

onChatBoost

fun FunctionalHandlingDsl.onChatBoost(block: suspend ActivityCtx<ChatBoostUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.chatBoost in the eu.vendeli.tgbot.types.Update.

onChatJoinRequest

fun FunctionalHandlingDsl.onChatJoinRequest(block: suspend ActivityCtx<ChatJoinRequestUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.chatJoinRequest in the eu.vendeli.tgbot.types.Update.

onChatMember

fun FunctionalHandlingDsl.onChatMember(block: suspend ActivityCtx<ChatMemberUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.chatMember in the eu.vendeli.tgbot.types.Update.

onChosenInlineResult

fun FunctionalHandlingDsl.onChosenInlineResult(block: suspend ActivityCtx<ChosenInlineResultUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.chosenInlineResult in the eu.vendeli.tgbot.types.Update.

onCommand

fun onCommand(command: String, scope: Set<UpdateType> = DEFAULT_SCOPE, rateLimits: RateLimits = RateLimits.NOT_LIMITED, guard: Guard = DefaultGuard, argParser: KClass<out ArgumentParser> = DefaultArgParser::class, block: OnCommandActivity)

The action that is performed when the command is matched.

onDeletedBusinessMessages

fun FunctionalHandlingDsl.onDeletedBusinessMessages(block: suspend ActivityCtx<DeletedBusinessMessagesUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.deletedBusinessMessages in the eu.vendeli.tgbot.types.Update.

onEditedBusinessMessage

fun FunctionalHandlingDsl.onEditedBusinessMessage(block: suspend ActivityCtx<EditedBusinessMessageUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.editedBusinessMessage in the eu.vendeli.tgbot.types.Update.

onEditedChannelPost

fun FunctionalHandlingDsl.onEditedChannelPost(block: suspend ActivityCtx<EditedChannelPostUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.editedChannelPost in the eu.vendeli.tgbot.types.Update.

onEditedMessage

fun FunctionalHandlingDsl.onEditedMessage(block: suspend ActivityCtx<EditedMessageUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.editedMessage in the eu.vendeli.tgbot.types.Update.

onInlineQuery

fun FunctionalHandlingDsl.onInlineQuery(block: suspend ActivityCtx<InlineQueryUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.inlineQuery in the eu.vendeli.tgbot.types.Update.

onInput

fun onInput(identifier: String, rateLimits: RateLimits = RateLimits.NOT_LIMITED, guard: Guard = DefaultGuard, block: OnInputActivity)

The action that is performed when the input is matched.

onMessage

fun FunctionalHandlingDsl.onMessage(block: suspend ActivityCtx<MessageUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.message in the eu.vendeli.tgbot.types.Update.

onMessageReaction

fun FunctionalHandlingDsl.onMessageReaction(block: suspend ActivityCtx<MessageReactionUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.messageReaction in the eu.vendeli.tgbot.types.Update.

onMessageReactionCount

fun FunctionalHandlingDsl.onMessageReactionCount(block: suspend ActivityCtx<MessageReactionCountUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.messageReactionCount in the eu.vendeli.tgbot.types.Update.

onMyChatMember

fun FunctionalHandlingDsl.onMyChatMember(block: suspend ActivityCtx<MyChatMemberUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.myChatMember in the eu.vendeli.tgbot.types.Update.

onPoll

fun FunctionalHandlingDsl.onPoll(block: suspend ActivityCtx<PollUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.poll in the eu.vendeli.tgbot.types.Update.

onPollAnswer

fun FunctionalHandlingDsl.onPollAnswer(block: suspend ActivityCtx<PollAnswerUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.pollAnswer in the eu.vendeli.tgbot.types.Update.

onPreCheckoutQuery

fun FunctionalHandlingDsl.onPreCheckoutQuery(block: suspend ActivityCtx<PreCheckoutQueryUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.preCheckoutQuery in the eu.vendeli.tgbot.types.Update.

onPurchasedPaidMedia

fun FunctionalHandlingDsl.onPurchasedPaidMedia(block: suspend ActivityCtx<PurchasedPaidMediaUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.purchasedPaidMedia in the eu.vendeli.tgbot.types.Update.

onRemovedChatBoost

fun FunctionalHandlingDsl.onRemovedChatBoost(block: suspend ActivityCtx<RemovedChatBoostUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.removedChatBoost in the eu.vendeli.tgbot.types.Update.

onShippingQuery

fun FunctionalHandlingDsl.onShippingQuery(block: suspend ActivityCtx<ShippingQueryUpdate>.() -> Unit)

Action that is performed on the presence of eu.vendeli.tgbot.types.Update.shippingQuery in the eu.vendeli.tgbot.types.Update.

whenNotHandled

fun whenNotHandled(block: WhenNotHandledActivity)

Action that will be applied when none of the other handlers process the data