1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-12-28 03:27:13 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.extensions.utils.updates/filter-commands-with-args.html
2022-01-14 10:54:38 +00:00

42 lines
8.8 KiB
HTML

<html>
<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>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.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"><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" defer="defer"></script><script type="text/javascript" src="../../scripts/prism.js" async="async"></script> </head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name"><a href="../../index.html">docs</a></div>
<div></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>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.extensions.utils.updates//filterCommandsWithArgs/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[dev.inmo.tgbotapi.types.update.abstracts.BaseSentMessageUpdate])]#kotlin.text.Regex/PointingToDeclaration//-1982836883">
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.extensions.utils.updates</a>/<a href="filter-commands-with-args.html">filterCommandsWithArgs</a></div>
<div class="cover ">
<h1 class="cover"><span>filter</span><wbr></wbr><span>Commands</span><wbr></wbr><span>With</span><wbr></wbr><span><span>Args</span></span></h1>
</div>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/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="../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>commandRegex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><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="../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="../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="../dev.inmo.tgbotapi.types.MessageEntity.textsources/index.html#-828955009%2FClasslikes%2F-1982836883">TextSourcesList</a><span class="token operator">&gt;</span><span class="token operator">&gt;</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><p class="paragraph">Convert incoming <a href="../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="../dev.inmo.tgbotapi.types.MessageEntity.textsources/-text-source/index.html">TextSource</a> as <a href="../dev.inmo.tgbotapi.types.MessageEntity.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="../dev.inmo.tgbotapi.types.MessageEntity.textsources/-text-source/index.html">TextSource</a> objects used next rules: all incoming text sources will be passed as is, <a href="../dev.inmo.tgbotapi.types.MessageEntity.textsources/-regular-text-source/index.html">RegularTextSource</a> will be split by &quot; &quot; for several <a href="../dev.inmo.tgbotapi.types.MessageEntity.textsources/-regular-text-source/index.html">RegularTextSource</a> which will contains not empty args without spaces.</p><h4 class="">Return</h4><p class="paragraph">Paired original message and converted list with first entity <a href="../dev.inmo.tgbotapi.types.MessageEntity.textsources/-bot-command-text-source/index.html">BotCommandTextSource</a> and than all others according to rules in description</p><h2 class="">See also</h2><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"><div class=""><span class="inline-flex"><div><span>full</span><wbr></wbr><span>Entities</span><wbr></wbr><span><span>List</span></span></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><a href="as-content-messages-flow.html"><span>as</span><wbr></wbr><span>Content</span><wbr></wbr><span>Messages</span><wbr></wbr><span><span>Flow</span></span></a></div></span></div><div><div class="title"><div data-togglable="See also"></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"><div class=""><span class="inline-flex"><div><a href="../dev.inmo.tgbotapi.extensions.utils/only-text-content-messages.html"><span>only</span><wbr></wbr><span>Text</span><wbr></wbr><span>Content</span><wbr></wbr><span><span>Messages</span></span></a></div></span></div><div><div class="title"><div data-togglable="See also"></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>© 2022 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>