1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-29 21:48:43 +00:00
tgbotapi/tgbotapi.utils/dev.inmo.tgbotapi.extensions.utils.updates/filter-commands-with-args.html
2023-11-05 06:58:16 +00:00

77 lines
9.4 KiB
HTML

<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>filterCommandsWithArgs</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.utils: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.utils::dev.inmo.tgbotapi.extensions.utils.updates//filterCommandsWithArgs/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[dev.inmo.tgbotapi.types.update.abstracts.BaseSentMessageUpdate])]#kotlin.text.Regex/PointingToDeclaration//-957209142">
<div class="breadcrumbs"><a href="../index.html">tgbotapi.utils</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.utils.updates</a><span class="delimiter">/</span><span class="current">filterCommandsWithArgs</span></div>
<div class="cover ">
<h1 class="cover"><span>filter</span><wbr><span>Commands</span><wbr><span>With</span><wbr><span><span>Args</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.utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="filter-commands-with-args.html">T</a><span class="token operator"> : </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-base-sent-message-update/index.html">BaseSentMessageUpdate</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="filter-commands-with-args.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="filter-commands-with-args.html"><span class="token function">filterCommandsWithArgs</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">commandRegex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator">&lt;</span><span class="token keyword"></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 punctuation">, </span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-text-sources-list/index.html">TextSourcesList</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><p class="paragraph">Convert incoming <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/content.html">dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content</a> of messages with fullEntitiesList and check that incoming message contains first <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-text-source/index.html">TextSource</a> as <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-bot-command-text-source/index.html">BotCommandTextSource</a>. Besides, it is checking that <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/matches.html">BotCommandTextSource.command</a> with incoming <a href="filter-commands-with-args.html">commandRegex</a> and for other <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-text-source/index.html">TextSource</a> objects used next rules: all incoming text sources will be passed as is, <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-regular-text-source/index.html">RegularTextSource</a> will be split by " " for several <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-regular-text-source/index.html">RegularTextSource</a> which will contains not empty args without spaces.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">Paired original message and converted list with first entity <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.textsources/-bot-command-text-source/index.html">BotCommandTextSource</a> and than all others according to rules in description</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.utils:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span>full</span><wbr><span>Entities</span><wbr><span><span>List</span></span></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.utils:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="as-content-messages-flow.html"><span>as</span><wbr><span>Content</span><wbr><span>Messages</span><wbr><span><span>Flow</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":tgbotapi.utils:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.utils:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../dev.inmo.tgbotapi.extensions.utils/only-text-content-messages.html"><span>only</span><wbr><span>Text</span><wbr><span>Content</span><wbr><span><span>Messages</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>© 2023 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>