mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-13 20:03:47 +00:00
77 lines
13 KiB
HTML
77 lines
13 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>onPinnedMessage</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: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::dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling//onPinnedMessage/TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext])#dev.inmo.tgbotapi.extensions.behaviour_builder.utils.SimpleFilter[dev.inmo.tgbotapi.types.message.abstracts.ChatEventMessage[dev.inmo.tgbotapi.types.message.ChatEvents.PinnedMessage]]?#kotlin.coroutines.SuspendFunction3[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),dev.inmo.tgbotapi.types.message.abstracts.ChatEventMessage[dev.inmo.tgbotapi.types.message.ChatEvents.PinnedMessage],dev.inmo.tgbotapi.types.update.abstracts.Update,kotlin.Boolean]?#dev.inmo.tgbotapi.extensions.behaviour_builder.utils.marker_factories.MarkerFactory[dev.inmo.tgbotapi.types.message.abstracts.ChatEventMessage[dev.inmo.tgbotapi.types.message.ChatEvents.PinnedMessage],kotlin.Any]?#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),dev.inmo.tgbotapi.types.message.abstracts.ChatEventMessage[dev.inmo.tgbotapi.types.message.ChatEvents.PinnedMessage],kotlin.Unit]/PointingToDeclaration//148860642">
|
|
<div class="breadcrumbs"><a href="../index.html">tgbotapi.behaviour_builder</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling</a><span class="delimiter">/</span><span class="current">onPinnedMessage</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>on</span><wbr><span>Pinned</span><wbr><span><span>Message</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:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="on-pinned-message.html">BC</a><span class="token operator"> : </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html">BehaviourContext</a><span class="token operator">> </span><a href="on-pinned-message.html">BC</a><span class="token punctuation">.</span><a href="on-pinned-message.html"><span class="token function">onPinnedMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">initialFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils/-simple-filter/index.html">SimpleFilter</a><span class="token operator"><</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-chat-event-message/index.html">ChatEventMessage</a><span class="token operator"><</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.-chat-events/-pinned-message/index.html">PinnedMessage</a><span class="token operator">></span><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 ">subcontextUpdatesFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-custom-behaviour-context-and-two-types-receiver/index.html">CustomBehaviourContextAndTwoTypesReceiver</a><span class="token operator"><</span><a href="on-pinned-message.html">BC</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-chat-event-message/index.html">ChatEventMessage</a><span class="token operator"><</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.-chat-events/-pinned-message/index.html">PinnedMessage</a><span class="token operator">></span><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>MessageFilterByChat<span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils.marker_factories/-marker-factory/index.html">MarkerFactory</a><span class="token operator"><</span><span class="token keyword">in </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-chat-event-message/index.html">ChatEventMessage</a><span class="token operator"><</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.-chat-events/-pinned-message/index.html">PinnedMessage</a><span class="token operator">></span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>ByChatMessageMarkerFactory<span class="token punctuation">, </span></span><span class="parameter ">scenarioReceiver<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-custom-behaviour-context-and-type-receiver/index.html">CustomBehaviourContextAndTypeReceiver</a><span class="token operator"><</span><a href="on-pinned-message.html">BC</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-chat-event-message/index.html">ChatEventMessage</a><span class="token operator"><</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.-chat-events/-pinned-message/index.html">PinnedMessage</a><span class="token operator">></span><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>initial</span><wbr><span><span>Filter</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This filter will be called to remove unnecessary data BEFORE <a href="on-pinned-message.html">scenarioReceiver</a> call</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>subcontext</span><wbr><span>Updates</span><wbr><span><span>Filter</span></span></u></div></span></div><div><div class="title"><p class="paragraph">This filter will be applied to each update inside of <a href="on-pinned-message.html">scenarioReceiver</a>. For example, this filter will be used if you will call <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.expectations/wait-content-message.html">dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitContentMessage</a>. Use <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context-and-two-types-receiver/index.html">dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContextAndTwoTypesReceiver</a> function to create your own. Use <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils/plus.html">dev.inmo.tgbotapi.extensions.behaviour_builder.utils.plus</a> or <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils/times.html">dev.inmo.tgbotapi.extensions.behaviour_builder.utils.times</a> to combinate several filters</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>marker</span><wbr><span><span>Factory</span></span></u></div></span></div><div><div class="title"><p class="paragraph"><strong>Pass null to handle requests fully parallel</strong>. Will be used to identify different "stream". <a href="on-pinned-message.html">scenarioReceiver</a> will be called synchronously in one "stream". Output of <a href="on-pinned-message.html">markerFactory</a> will be used as a key for "stream"</p></div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>scenario</span><wbr><span><span>Receiver</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Main callback which will be used to handle incoming data if <a href="on-pinned-message.html">initialFilter</a> will pass that data</p></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>
|
|
|