mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-19 14:53:48 +00:00
46 lines
14 KiB
HTML
46 lines
14 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>telegramBotWithBehaviour</title>
|
|
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../scripts/main.js" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.extensions.behaviour_builder//telegramBotWithBehaviour/#kotlin.String#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlinx.coroutines.CoroutineScope?#kotlin.String#kotlin.Function1[dev.inmo.tgbotapi.bot.Ktor.KtorRequestsExecutorBuilder,kotlin.Unit]#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration//-1982836883">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder</a>/<a href="telegram-bot-with-behaviour.html">telegramBotWithBehaviour</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":docs:dokkaHtml/commonMain">common</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>telegram</span><wbr></wbr><span>Bot</span><wbr></wbr><span>With</span><wbr></wbr><span>Behaviour</span></h1>
|
|
</div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">suspend fun <a href="telegram-bot-with-behaviour.html">telegramBotWithBehaviour</a>(token: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, flowsUpdatesFilter: <a href="../dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a>, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>? = null, apiUrl: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = telegramBotAPIDefaultUrl, builder: <a href="../dev.inmo.tgbotapi.bot.Ktor/-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}, defaultExceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>? = null, block: <a href="index.html#1125173050%2FClasslikes%2F-1982836883">BehaviourContextReceiver</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>): <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<p class="paragraph">Create bot using <a href="../dev.inmo.tgbotapi.bot.Ktor/telegram-bot.html">telegramBot</a> and start listening for updates using <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviour/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.CoroutineScope#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration/">buildBehaviour</span>. Use this method in case you wish to make some additional actions with <a href="telegram-bot-with-behaviour.html">flowsUpdatesFilter</a>.</p><p class="paragraph">WARNING This method WILL NOT launch any listening of updates. Use something like <a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a> or tools for work with webhooks</p><h4 class="">Return</h4><p class="paragraph">Created bot which has been used to create <a href="-behaviour-context/index.html">BehaviourContext</a> via <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviour/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.CoroutineScope#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration/">buildBehaviour</span></p><h2 class="">See also</h2><div data-togglable="See also"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="See also"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="-behaviour-context/index.html">dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviour/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.CoroutineScope#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration/">buildBehaviour</span></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div></div></div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">suspend fun <a href="telegram-bot-with-behaviour.html">telegramBotWithBehaviour</a>(token: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, scope: <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>? = null, apiUrl: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = telegramBotAPIDefaultUrl, builder: <a href="../dev.inmo.tgbotapi.bot.Ktor/-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}, defaultExceptionsHandler: <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>? = null, block: <a href="index.html#1125173050%2FClasslikes%2F-1982836883">BehaviourContextReceiver</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><<a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a>, <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<p class="paragraph">Create bot using <a href="../dev.inmo.tgbotapi.bot.Ktor/telegram-bot.html">telegramBot</a> and start listening for updates using <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviour/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.CoroutineScope#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration/">buildBehaviour</span>. Use this method in case you wish to make some additional actions with flowsUpdatesFilter.</p><p class="paragraph">WARNING This method WILL NOT launch any listening of updates. Use something like <a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a> or tools for work with webhooks</p><h4 class="">Return</h4><p class="paragraph">Pair of <a href="../dev.inmo.tgbotapi.bot/index.html#-1167693203%2FClasslikes%2F-1982836883">TelegramBot</a> and <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>. This <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> can be used to stop listening updates in your <a href="telegram-bot-with-behaviour.html">block</a> you passed here</p><h2 class="">See also</h2><div data-togglable="See also"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="See also"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="-behaviour-context/index.html">dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder//buildBehaviour/dev.inmo.tgbotapi.bot.RequestsExecutor#kotlinx.coroutines.CoroutineScope#dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext,kotlin.Unit]/PointingToDeclaration/">buildBehaviour</span></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes RowTitle"><div class=""><span class="inline-flex"><a href="../dev.inmo.tgbotapi.extensions.utils.updates.retrieving/start-getting-of-updates-by-long-polling.html">startGettingOfUpdatesByLongPolling</a></span><span class="inline-flex"><div data-togglable="See also"></div></span></div><div></div></div></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|