docs/dev.inmo.tgbotapi.extensions.utils.updates.retrieving

Package dev.inmo.tgbotapi.extensions.utils.updates.retrieving

Functions

includeWebhookHandlingInRoute

jvm

Allows to include webhook in custom route everywhere in your server

fun Route.includeWebhookHandlingInRoute(scope: CoroutineScope, exceptionsHandler: SuspendFunction1<Throwable, Unit>?, block: SuspendFunction1<Update, Unit>)

includeWebhookHandlingInRouteWithFlows

jvm

fun Route.includeWebhookHandlingInRouteWithFlows(scope: CoroutineScope, exceptionsHandler: SuspendFunction1<Throwable, Unit>?, block: FlowsUpdatesFilter.() -> Unit)

setWebhookInfoAndStartListenWebhooks

jvm

Setting up ktor server, set webhook info via SetWebhookRequest request.

suspend fun RequestsExecutor.setWebhookInfoAndStartListenWebhooks(listenPort: Int, engineFactory: ApplicationEngineFactory<*, *>, setWebhookRequest: SetWebhookRequest, exceptionsHandler: SuspendFunction1<Throwable, Unit>, listenHost: String, listenRoute: String, privateKeyConfig: WebhookPrivateKeyConfig?, scope: CoroutineScope, block: SuspendFunction1<Update, Unit>): ApplicationEngine

startGettingFlowsUpdatesByLongPolling

This method will create a new one FlowsUpdatesFilter. This method could be unsafe due to the fact that it will start getting updates IMMEDIATELY. That means that your bot will be able to skip some of them until you will call kotlinx.coroutines.flow.Flow.collect on one of FlowsUpdatesFilter flows. To avoid it, you can pass flowUpdatesPreset lambda - it will be called BEFORE starting updates getting

common

@FlowPreview()

fun RequestsExecutor.startGettingFlowsUpdatesByLongPolling(timeoutSeconds: Int, scope: CoroutineScope, exceptionsHandler: SuspendFunction1<Throwable, Unit>?, flowsUpdatesFilterUpdatesKeeperCount: Int, flowUpdatesPreset: FlowsUpdatesFilter.() -> Unit): FlowsUpdatesFilter

startGettingOfUpdatesByLongPolling

common

fun RequestsExecutor.startGettingOfUpdatesByLongPolling(updatesFilter: UpdatesFilter, timeoutSeconds: Int, exceptionsHandler: SuspendFunction1<Throwable, Unit>?, scope: CoroutineScope): Job

fun RequestsExecutor.startGettingOfUpdatesByLongPolling(timeoutSeconds: Int, scope: CoroutineScope, exceptionsHandler: SuspendFunction1<Throwable, Unit>?, allowedUpdates: List<String>?, updatesReceiver: SuspendFunction1<Update, Unit>): Job

startListenWebhooks

jvm

Setting up ktor server

fun startListenWebhooks(listenPort: Int, engineFactory: ApplicationEngineFactory<*, *>, exceptionsHandler: SuspendFunction1<Throwable, Unit>, listenHost: String, listenRoute: String?, privateKeyConfig: WebhookPrivateKeyConfig?, scope: CoroutineScope, block: SuspendFunction1<Update, Unit>): ApplicationEngine

updateHandlerWithMediaGroupsAdaptation

Create UpdateReceiver object which will correctly accumulate updates and send into output updates which INCLUDE dev.inmo.tgbotapi.types.update.MediaGroupUpdates.MediaGroupUpdates.

common

fun CoroutineScope.updateHandlerWithMediaGroupsAdaptation(output: SuspendFunction1<Update, Unit>): SuspendFunction1<Update, Unit>

fun CoroutineScope.updateHandlerWithMediaGroupsAdaptation(output: SuspendFunction1<Update, Unit>, debounceTimeMillis: Long): SuspendFunction1<Update, Unit>