mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-27 04:28:44 +00:00
40 lines
11 KiB
HTML
40 lines
11 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>onMediaCollection</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.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" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling//onMediaCollection/TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext])#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[dev.inmo.tgbotapi.types.message.content.abstracts.MediaCollectionContent[dev.inmo.tgbotapi.types.files.abstracts.TelegramMediaFile]],kotlin.Boolean]?#kotlin.coroutines.SuspendFunction3[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[dev.inmo.tgbotapi.types.message.content.abstracts.MediaCollectionContent[dev.inmo.tgbotapi.types.files.abstracts.TelegramMediaFile]],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.CommonMessage[dev.inmo.tgbotapi.types.message.content.abstracts.MediaCollectionContent[dev.inmo.tgbotapi.types.files.abstracts.TelegramMediaFile]],kotlin.Any]#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[dev.inmo.tgbotapi.types.message.content.abstracts.MediaCollectionContent[dev.inmo.tgbotapi.types.files.abstracts.TelegramMediaFile]],kotlin.Unit]/PointingToDeclaration//-1982836883">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling</a>/<a href="on-media-collection.html">onMediaCollection</a></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>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>on</span><wbr></wbr><span>Media</span><wbr></wbr><span><span>Collection</span></span></h1>
|
|
</div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">suspend fun <<a href="on-media-collection.html">BC</a> : <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/-behaviour-context/index.html">BehaviourContext</a>> <a href="on-media-collection.html">BC</a>.<a href="on-media-collection.html">onMediaCollection</a>(initialFilter: <a href="index.html#-1990656072%2FClasslikes%2F-1982836883">CommonMessageFilter</a><<a href="../dev.inmo.tgbotapi.types.message.content.abstracts/-media-collection-content/index.html">MediaCollectionContent</a><<a href="../dev.inmo.tgbotapi.types.files.abstracts/-telegram-media-file/index.html">TelegramMediaFile</a>>>? = null, subcontextUpdatesFilter: <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/index.html#-1990833289%2FClasslikes%2F-1982836883">CustomBehaviourContextAndTwoTypesReceiver</a><<a href="on-media-collection.html">BC</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, <a href="../dev.inmo.tgbotapi.types.message.abstracts/-common-message/index.html">CommonMessage</a><<a href="../dev.inmo.tgbotapi.types.message.content.abstracts/-media-collection-content/index.html">MediaCollectionContent</a><<a href="../dev.inmo.tgbotapi.types.files.abstracts/-telegram-media-file/index.html">TelegramMediaFile</a>>>, <a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a>> = MessageFilterByChat, markerFactory: <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils.marker_factories/-marker-factory/index.html">MarkerFactory</a><in <a href="../dev.inmo.tgbotapi.types.message.abstracts/-common-message/index.html">CommonMessage</a><<a href="../dev.inmo.tgbotapi.types.message.content.abstracts/-media-collection-content/index.html">MediaCollectionContent</a><<a href="../dev.inmo.tgbotapi.types.files.abstracts/-telegram-media-file/index.html">TelegramMediaFile</a>>>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>> = ByChatMessageMarkerFactory, scenarioReceiver: <a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/index.html#-1311499158%2FClasslikes%2F-1982836883">CustomBehaviourContextAndTypeReceiver</a><<a href="on-media-collection.html">BC</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>, <a href="../dev.inmo.tgbotapi.types.message.abstracts/-common-message/index.html">CommonMessage</a><<a href="../dev.inmo.tgbotapi.types.message.content.abstracts/-media-collection-content/index.html">MediaCollectionContent</a><<a href="../dev.inmo.tgbotapi.types.files.abstracts/-telegram-media-file/index.html">TelegramMediaFile</a>>>>): <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</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></div></div>
|
|
</div>
|
|
<h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><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"><span>initial</span><wbr></wbr><span><span>Filter</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">This filter will be called to remove unnecessary data BEFORE <a href="on-media-collection.html">scenarioReceiver</a> call</p></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"><span>subcontext</span><wbr></wbr><span>Updates</span><wbr></wbr><span><span>Filter</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">This filter will be applied to each update inside of <a href="on-media-collection.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/index.html#-1930437658%2FClasslikes%2F-1982836883">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><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"><span>marker</span><wbr></wbr><span><span>Factory</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Will be used to identify different "stream". <a href="on-media-collection.html">scenarioReceiver</a> will be called synchronously in one "stream". Output of <a href="on-media-collection.html">markerFactory</a> will be used as a key for "stream"</p></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"><span>scenario</span><wbr></wbr><span><span>Receiver</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Main callback which will be used to handle incoming data if <a href="on-media-collection.html">initialFilter</a> will pass that data</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"></a></span><span>© 2021 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>
|
|
|