tgbotapi/tgbotapi.api/dev.inmo.tgbotapi.extension.../send-regular-poll.html

<!doctype html>
<html class="no-js">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
    <title>sendRegularPoll</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.api: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.api::dev.inmo.tgbotapi.extensions.api.send.polls//sendRegularPoll/dev.inmo.tgbotapi.bot.RequestsExecutor#dev.inmo.tgbotapi.types.ChatIdentifier#kotlin.String#kotlin.collections.List[kotlin.String]#kotlin.Boolean#kotlin.Boolean#kotlin.Boolean#dev.inmo.tgbotapi.types.polls.ScheduledCloseInfo?#kotlin.Long?#kotlin.Boolean#kotlin.Boolean#dev.inmo.tgbotapi.types.ReplyParameters?#dev.inmo.tgbotapi.types.buttons.KeyboardMarkup?/PointingToDeclaration//378952897">
  <div class="breadcrumbs"><a href="../index.html">tgbotapi.api</a><span class="delimiter">/</span><a href="index.html">dev.inmo.tgbotapi.extensions.api.send.polls</a><span class="delimiter">/</span><span class="current">sendRegularPoll</span></div>
  <div class="cover ">
    <h1 class="cover"><span>send</span><wbr><span>Regular</span><wbr><span><span>Poll</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.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="send-regular-poll.html"><span class="token function">sendRegularPoll</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">chatId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter ">question<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 ">options<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">isAnonymous<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 ">isClosed<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 ">allowMultipleAnswers<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 ">closeInfo<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-scheduled-close-info/index.html">ScheduledCloseInfo</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">threadId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-thread-id/index.html">MessageThreadId</a><span class="token operator">?</span><span class="token operator"> = </span>chatId.threadId<span class="token punctuation">, </span></span><span class="parameter ">disableNotification<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 ">protectContent<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 ">replyParameters<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-reply-parameters/index.html">ReplyParameters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.buttons/-keyboard-markup/index.html">KeyboardMarkup</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-poll-content/index.html">PollContent</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="send-regular-poll.html"><span class="token function">sendRegularPoll</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">chatId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter ">poll<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-regular-poll/index.html">RegularPoll</a><span class="token punctuation">, </span></span><span class="parameter ">isClosed<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 ">question<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>poll.question<span class="token punctuation">, </span></span><span class="parameter ">options<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>poll.options.map { it.text }<span class="token punctuation">, </span></span><span class="parameter ">isAnonymous<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>poll.isAnonymous<span class="token punctuation">, </span></span><span class="parameter ">allowMultipleAnswers<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>poll.allowMultipleAnswers<span class="token punctuation">, </span></span><span class="parameter ">closeInfo<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-scheduled-close-info/index.html">ScheduledCloseInfo</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">threadId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-thread-id/index.html">MessageThreadId</a><span class="token operator">?</span><span class="token operator"> = </span>chatId.threadId<span class="token punctuation">, </span></span><span class="parameter ">disableNotification<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 ">protectContent<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 ">replyParameters<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-reply-parameters/index.html">ReplyParameters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.buttons/-keyboard-markup/index.html">KeyboardMarkup</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-poll-content/index.html">PollContent</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="send-regular-poll.html"><span class="token function">sendRegularPoll</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">chat<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.chat/-chat/index.html">Chat</a><span class="token punctuation">, </span></span><span class="parameter ">question<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 ">options<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">isAnonymous<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 ">isClosed<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 ">allowMultipleAnswers<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 ">closeInfo<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-scheduled-close-info/index.html">ScheduledCloseInfo</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">threadId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-thread-id/index.html">MessageThreadId</a><span class="token operator">?</span><span class="token operator"> = </span>chat.id.threadId<span class="token punctuation">, </span></span><span class="parameter ">disableNotification<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 ">protectContent<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 ">replyParameters<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-reply-parameters/index.html">ReplyParameters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.buttons/-keyboard-markup/index.html">KeyboardMarkup</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-poll-content/index.html">PollContent</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a><span class="token punctuation">.</span><a href="send-regular-poll.html"><span class="token function">sendRegularPoll</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">chat<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.chat/-chat/index.html">Chat</a><span class="token punctuation">, </span></span><span class="parameter ">poll<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-regular-poll/index.html">RegularPoll</a><span class="token punctuation">, </span></span><span class="parameter ">isClosed<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 ">question<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>poll.question<span class="token punctuation">, </span></span><span class="parameter ">options<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>poll.options.map { it.text }<span class="token punctuation">, </span></span><span class="parameter ">isAnonymous<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>poll.isAnonymous<span class="token punctuation">, </span></span><span class="parameter ">allowMultipleAnswers<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>poll.allowMultipleAnswers<span class="token punctuation">, </span></span><span class="parameter ">closeInfo<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-scheduled-close-info/index.html">ScheduledCloseInfo</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">threadId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-thread-id/index.html">MessageThreadId</a><span class="token operator">?</span><span class="token operator"> = </span>chat.id.threadId<span class="token punctuation">, </span></span><span class="parameter ">disableNotification<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 ">protectContent<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 ">replyParameters<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-reply-parameters/index.html">ReplyParameters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.buttons/-keyboard-markup/index.html">KeyboardMarkup</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator">&lt;</span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-poll-content/index.html">PollContent</a><span class="token operator">&gt;</span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.api:dokkaHtmlPartial/commonMain" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>reply</span><wbr><span><span>Markup</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Some of <a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.buttons/-keyboard-markup/index.html">KeyboardMarkup</a>. See dev.inmo.tgbotapi.extensions.utils.types.buttons.replyKeyboard or dev.inmo.tgbotapi.extensions.utils.types.buttons.inlineKeyboard as a builders for that param</p></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>