mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-15 21:03:48 +00:00
77 lines
16 KiB
HTML
77 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>telegramBotWithBehaviourAndFSM</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js","js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
|
|
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
|
|
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
|
|
<script type="text/javascript" src="../../scripts/main.js" defer></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async></script>
|
|
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
|
|
<body>
|
|
<div class="root">
|
|
<nav class="navigation" id="navigation-wrapper">
|
|
<div class="navigation--inner">
|
|
<div class="navigation-title">
|
|
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
|
<div class="library-name">
|
|
<a class="library-name--link" href="../../index.html">
|
|
ktgbotapi
|
|
</a> </div>
|
|
<div class="library-version">
|
|
</div>
|
|
</div>
|
|
<div class="filter-section" id="filter-section">
|
|
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain">common</button>
|
|
</div>
|
|
</div>
|
|
<div class="navigation-controls">
|
|
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
|
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
|
</div>
|
|
</nav>
|
|
<div id="container">
|
|
<div class="sidebar" id="leftColumn">
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" data-page-type="member" id="content" pageids="tgbotapi.behaviour_builder.fsm::dev.inmo.tgbotapi.extensions.behaviour_builder//telegramBotWithBehaviourAndFSM/#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]?#dev.inmo.micro_utils.fsm.common.StatesManager[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]#kotlin.collections.List[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourWithFSMStateHandlerHolder[*,TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]]#dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourWithFSMStateHandlerHolder[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]?#kotlin.Boolean#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State]),kotlin.Throwable,TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])?]#kotlin.Int#kotlin.Boolean#kotlin.Boolean#kotlin.Long?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.extensions.behaviour_builder.DefaultBehaviourContextWithFSM[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])],kotlin.Unit]/PointingToDeclaration//983072464">
|
|
<div class="breadcrumbs"><a href="../index.html">tgbotapi.behaviour_builder.fsm</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder</a><span class="delimiter">/</span><span class="current">telegramBotWithBehaviourAndFSM</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>telegram</span><wbr><span>Bot</span><wbr><span>With</span><wbr><span>Behaviour</span><wbr><span>And</span><wbr><span><span>FSM</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator"> : </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/State///PointingToDeclaration/">State</span><span class="token operator">> </span><a href="telegram-bot-with-behaviour-and-f-s-m.html"><span class="token function">telegramBotWithBehaviourAndFSM</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">token<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">flowsUpdatesFilter<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.updateshandlers/-flows-updates-filter/index.html">FlowsUpdatesFilter</a><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">apiUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>telegramBotAPIDefaultUrl<span class="token punctuation">, </span></span><span class="parameter ">builder<span class="token operator">: </span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor/-ktor-requests-executor-builder/index.html">KtorRequestsExecutorBuilder</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">defaultExceptionsHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.coroutines/ExceptionHandler///PointingToDeclaration/">ExceptionHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">statesManager<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesManager///PointingToDeclaration/">StatesManager</span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>DefaultStatesManager(InMemoryDefaultStatesManagerRepo())<span class="token punctuation">, </span></span><span class="parameter ">presetHandlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token operator"> = </span>listOf()<span class="token punctuation">, </span></span><span class="parameter ">fallbackHandler<span class="token operator">: </span><a href="-behaviour-with-f-s-m-state-handler-holder/index.html">BehaviourWithFSMStateHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">testServer<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">onStateHandlingErrorHandler<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.fsm.common.utils/StateHandlingErrorHandler///PointingToDeclaration/">StateHandlingErrorHandler</span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator">></span><span class="token operator"> = </span>defaultStateHandlingErrorHandler()<span class="token punctuation">, </span></span><span class="parameter ">timeoutSeconds<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-seconds/index.html">Seconds</a><span class="token operator"> = </span><span class="token constant">30</span><span class="token punctuation">, </span></span><span class="parameter ">autoDisableWebhooks<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">autoSkipTimeoutExceptions<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">mediaGroupsDebounceTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span><span class="token constant">1000</span><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><a href="../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-custom-behaviour-context-receiver/index.html">CustomBehaviourContextReceiver</a><span class="token operator"><</span><span class="token keyword"></span><a href="-default-behaviour-context-with-f-s-m/index.html">DefaultBehaviourContextWithFSM</a><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot-with-behaviour-and-f-s-m.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a></div><p class="paragraph">Create bot using <a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot.ktor/index.html">telegramBot</a> and start listening for updates using <a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a>. Use this method in case you wish to make some additional actions with <a href="telegram-bot-with-behaviour-and-f-s-m.html">flowsUpdatesFilter</a>.</p><p class="paragraph"><strong>WARNING</strong> This method WILL NOT launch any listening of updates. Use something like <a href="../../tgbotapi.utils/dev.inmo.tgbotapi.extensions.utils.updates.retrieving/index.html">startGettingOfUpdatesByLongPolling</a> or tools for work with webhooks</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">Created bot which has been used to create <a href="../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html">BehaviourContext</a> via <a href="build-behaviour-with-f-s-m.html">buildBehaviourWithFSM</a></p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>media</span><wbr><span>Groups</span><wbr><span>Debounce</span><wbr><span>Time</span><wbr><span><span>Millis</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used for calling of <a href="../../tgbotapi.utils/dev.inmo.tgbotapi.extensions.utils.updates.retrieving/index.html">updateHandlerWithMediaGroupsAdaptation</a>. Pass null in case you wish to enable classic way of updates handling, but in that mode some media group messages can be retrieved in different updates</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html"><span>Behaviour</span><wbr><span><span>Context</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="build-behaviour-with-f-s-m.html"><span>build</span><wbr><span>Behaviour</span><wbr><span>With</span><wbr><span><span>FSM</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder.fsm:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../tgbotapi.utils/dev.inmo.tgbotapi.extensions.utils.updates.retrieving/index.html"><span>start</span><wbr><span>Getting</span><wbr><span>Of</span><wbr><span>Updates</span><wbr><span>By</span><wbr><span>Long</span><wbr><span><span>Polling</span></span></a></div></span></div><div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 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>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|