<html> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>onVisualGallery</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.behaviour_builder.triggers_handling//onVisualGallery/TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext])#kotlin.coroutines.SuspendFunction1[kotlin.collections.List[dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage[dev.inmo.tgbotapi.types.message.content.media.VisualMediaGroupContent]],kotlin.Boolean]?#kotlin.coroutines.SuspendFunction3[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),kotlin.collections.List[dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage[dev.inmo.tgbotapi.types.message.content.media.VisualMediaGroupContent]],dev.inmo.tgbotapi.types.update.abstracts.Update,kotlin.Boolean]?#dev.inmo.tgbotapi.extensions.behaviour_builder.utils.marker_factories.MarkerFactory[kotlin.collections.List[dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage[dev.inmo.tgbotapi.types.message.content.media.VisualMediaGroupContent]],kotlin.Any]#kotlin.coroutines.SuspendFunction2[TypeParam(bounds=[dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext]),kotlin.collections.List[dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage[dev.inmo.tgbotapi.types.message.content.media.VisualMediaGroupContent]],kotlin.Unit]/PointingToDeclaration//-1982836883"> <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-visual-gallery.html">onVisualGallery</a></div> <div class="cover "> <h1 class="cover"><span>on</span><wbr></wbr><span>Visual</span><wbr></wbr><span><span>Gallery</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">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="on-visual-gallery.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-visual-gallery.html">BC</a><span class="token punctuation">.</span><a href="on-visual-gallery.html"><span class="token function">onVisualGallery</span></a><span class="token punctuation">(</span>initialFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder.utils/index.html#610075924%2FClasslikes%2F-1982836883">SimpleFilter</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.abstracts/-media-group-message/index.html">MediaGroupMessage</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.content.media/-visual-media-group-content/index.html">VisualMediaGroupContent</a><span class="token operator">></span><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>subcontextUpdatesFilter<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/index.html#-1990833289%2FClasslikes%2F-1982836883">CustomBehaviourContextAndTwoTypesReceiver</a><span class="token operator"><</span><span class="token keyword"></span><a href="on-visual-gallery.html">BC</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.abstracts/-media-group-message/index.html">MediaGroupMessage</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.content.media/-visual-media-group-content/index.html">VisualMediaGroupContent</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="../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>MessagesFilterByChat<span class="token punctuation">, </span>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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.abstracts/-media-group-message/index.html">MediaGroupMessage</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.content.media/-visual-media-group-content/index.html">VisualMediaGroupContent</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></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>ByChatMediaGroupMarkerFactory<span class="token punctuation">, </span>scenarioReceiver<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.extensions.behaviour_builder/index.html#-1311499158%2FClasslikes%2F-1982836883">CustomBehaviourContextAndTypeReceiver</a><span class="token operator"><</span><span class="token keyword"></span><a href="on-visual-gallery.html">BC</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.abstracts/-media-group-message/index.html">MediaGroupMessage</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.content.media/-visual-media-group-content/index.html">VisualMediaGroupContent</a><span class="token operator">></span><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">)</span><span class="token operator">: </span><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><h2 class="">Parameters</h2><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"><div><span>initial</span><wbr></wbr><span><span>Filter</span></span></div></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-visual-gallery.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"><div><span>subcontext</span><wbr></wbr><span>Updates</span><wbr></wbr><span><span>Filter</span></span></div></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-visual-gallery.html">scenarioReceiver</a>. For example, this filter will be used if you will call <span data-unresolved-link="dev.inmo.tgbotapi.extensions.behaviour_builder.expectations//waitContentMessage/dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext#kotlin.Int#dev.inmo.tgbotapi.requests.abstracts.Request[*]?#kotlin.Boolean#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.update.abstracts.Update,dev.inmo.tgbotapi.requests.abstracts.Request[*]?]#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[TypeParam(bounds=[dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent])],kotlin.Boolean]?#kotlin.coroutines.SuspendFunction1[dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[TypeParam(bounds=[dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent])],dev.inmo.tgbotapi.types.message.abstracts.CommonMessage[TypeParam(bounds=[dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent])]?]?/PointingToDeclaration/">dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitContentMessage</span>. 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"><div><span>marker</span><wbr></wbr><span><span>Factory</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Will be used to identify different "stream". <a href="on-visual-gallery.html">scenarioReceiver</a> will be called synchronously in one "stream". Output of <a href="on-visual-gallery.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"><div><span>scenario</span><wbr></wbr><span><span>Receiver</span></span></div></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-visual-gallery.html">initialFilter</a> will pass that data</p></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>