InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-25 19:48:43 +00:00
Code Releases Activity
kdocs
tgbotapi/tgbotapi.behaviour_builder/dev.inmo.tgbotapi.extensions.behaviour_builder.utils.extensions/index.html
InsanusMokrassar 81fd242c76 deploy: 4a0c0bdc40
2024-11-01 17:55:38 +00:00

119 lines
20 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.tgbotapi.extensions.behaviour_builder.utils.extensions</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="package" id="content" pageids="tgbotapi.behaviour_builder::dev.inmo.tgbotapi.extensions.behaviour_builder.utils.extensions////PointingToDeclaration//148860642">
<div class="breadcrumbs"><a href="../index.html">tgbotapi.behaviour_builder</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.extensions.behaviour_builder.utils.extensions</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button><button class="section-tab" data-togglable="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
<div class="tabs-section-body">
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="557141956%2FProperties%2F148860642" anchor-label="DefaultKTgBotAPIPrivacyCommand" id="557141956%2FProperties%2F148860642" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"></a>
<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><a href="-default-k-tg-bot-a-p-i-privacy-command.html"><span>Default</span><wbr><span>KTg</span><wbr><span>Bot</span><wbr><span>APIPrivacy</span><wbr><span><span>Command</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="557141956%2FProperties%2F148860642"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">const </span><span class="token keyword">val </span><a href="-default-k-tg-bot-a-p-i-privacy-command.html">DefaultKTgBotAPIPrivacyCommand</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-1909954342%2FFunctions%2F148860642" anchor-label="onCommandPrivacy" id="-1909954342%2FFunctions%2F148860642" data-filterable-set=":tgbotapi.behaviour_builder:dokkaHtmlPartial/commonMain"></a>
<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><a href="on-command-privacy.html"><span>on</span><wbr><span>Command</span><wbr><span><span>Privacy</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1909954342%2FFunctions%2F148860642"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">&lt;</span><a href="on-command-privacy.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">&gt; </span><a href="on-command-privacy.html">BC</a><span class="token punctuation">.</span><a href="on-command-privacy.html"><span class="token function">onCommandPrivacy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">requireOnlyCommandInMessage<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 ">initialFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling/-common-message-filter/index.html">CommonMessageFilter</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-content/index.html">TextContent</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>CommonMessageFilterExcludeMediaGroups<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">&lt;</span><a href="on-command-privacy.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.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<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">&lt;</span><span class="token keyword">in </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<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">&lt;</span><a href="on-command-privacy.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.content/-text-message/index.html">TextMessage</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Adding default handler for <code class="lang-kotlin">/privacy</code> command</p></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-command-privacy.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">&gt; </span><a href="on-command-privacy.html">BC</a><span class="token punctuation">.</span><a href="on-command-privacy.html"><span class="token function">onCommandPrivacy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">textSources<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">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-text-source/index.html">TextSource</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">requireOnlyCommandInMessage<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 ">initialFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling/-common-message-filter/index.html">CommonMessageFilter</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-content/index.html">TextContent</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>CommonMessageFilterExcludeMediaGroups<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">&lt;</span><a href="on-command-privacy.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.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">allowPaidBroadcast<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 ">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">&lt;</span><span class="token keyword">in </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Adding default handler for <code class="lang-kotlin">/privacy</code> command. It will send text message with <a href="on-command-privacy.html">textSources</a> as text.</p></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="on-command-privacy.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">&gt; </span><a href="on-command-privacy.html">BC</a><span class="token punctuation">.</span><a href="on-command-privacy.html"><span class="token function">onCommandPrivacy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">text<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 ">parseMode<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message/-parse-mode/index.html">ParseMode</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">requireOnlyCommandInMessage<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 ">initialFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling/-common-message-filter/index.html">CommonMessageFilter</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-content/index.html">TextContent</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>CommonMessageFilterExcludeMediaGroups<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">&lt;</span><a href="on-command-privacy.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.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">allowPaidBroadcast<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 ">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">&lt;</span><span class="token keyword">in </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-text-message/index.html">TextMessage</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Adding default handler for <code class="lang-kotlin">/privacy</code> command. It will send text message with <a href="on-command-privacy.html">text</a> as text and <a href="on-command-privacy.html">parseMode</a> if passed.</p></div></div></div>
</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>
View Git Blame Copy Permalink