1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-26 20:18:45 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.requests/index.html

184 lines
24 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.tgbotapi.requests</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</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="../../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>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></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">
<span>docs</span>
</a>
</div>
<div>
4.1.1 </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.requests////PointingToDeclaration//-1982836883">
<div class="breadcrumbs"><a href="../../index.html">docs</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.requests</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="415407686%2FClasslikes%2F-1982836883" anchor-label="DeleteMessage" id="415407686%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-delete-message/index.html"><span>Delete</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="415407686%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-delete-message/index.html">DeleteMessage</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>chatId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>messageId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#469798271%2FClasslikes%2F-1982836883">MessageId</a></span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt; </span>, <a href="../dev.inmo.tgbotapi.abstracts.types/-message-action/index.html">MessageAction</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1063165444%2FClasslikes%2F-1982836883" anchor-label="DownloadFile" id="-1063165444%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-download-file/index.html"><span>Download</span><wbr></wbr><span><span>File</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1063165444%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-download-file/index.html">DownloadFile</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>filePath<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1904227868%2FClasslikes%2F-1982836883" anchor-label="DownloadFileStream" id="1904227868%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-download-file-stream/index.html"><span>Download</span><wbr></wbr><span>File</span><wbr></wbr><span><span>Stream</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1904227868%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-download-file-stream/index.html">DownloadFileStream</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>filePath<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.utils/-byte-read-channel-allocator/index.html">ByteReadChannelAllocator</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1970768030%2FClasslikes%2F-1982836883" anchor-label="ForwardMessage" id="1970768030%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-forward-message/index.html"><span>Forward</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1970768030%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-forward-message/index.html">ForwardMessage</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>fromChatId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>toChatId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>messageId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#469798271%2FClasslikes%2F-1982836883">MessageId</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>threadId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#790562389%2FClasslikes%2F-1982836883">MessageThreadId</a><span class="token operator">?</span><span class="token operator"> = </span>toChatId.threadId<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>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 "><span class="token keyword">val </span>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></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.message.abstracts/-possibly-forwarded-message/index.html">PossiblyForwardedMessage</a><span class="token operator">&gt; </span>, <a href="../dev.inmo.tgbotapi.abstracts.types/-message-action/index.html">MessageAction</a>, <a href="../dev.inmo.tgbotapi.abstracts.types/-protect-content/index.html">ProtectContent</a>, <a href="../dev.inmo.tgbotapi.requests.send.abstracts/-optionally-message-thread-request/index.html">OptionallyMessageThreadRequest</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-996171444%2FClasslikes%2F-1982836883" anchor-label="GetUpdates" id="-996171444%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-get-updates/index.html"><span>Get</span><wbr></wbr><span><span>Updates</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-996171444%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-get-updates/index.html">GetUpdates</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>offset<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#-1668278897%2FClasslikes%2F-1982836883">UpdateIdentifier</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>limit<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>getUpdatesLimit.last<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>timeout<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#-1838927582%2FClasslikes%2F-1982836883">Seconds</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>allowed_updates<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><span class="token keyword"></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><span class="token operator"> = </span>ALL_UPDATES_LIST</span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><span class="token operator">&lt;</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">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Request updates from Telegram Bot API system. It is important, that the result updates WILL NOT include dev.inmo.tgbotapi.types.update.MediaGroupUpdates.MediaGroupUpdate objects due to the fact, that it is internal abstraction and in fact any dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage is just a common <a href="../dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">dev.inmo.tgbotapi.types.message.abstracts.Message</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-996986791%2FClasslikes%2F-1982836883" anchor-label="SetPassportDataErrors" id="-996986791%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-set-passport-data-errors/index.html"><span>Set</span><wbr></wbr><span>Passport</span><wbr></wbr><span>Data</span><wbr></wbr><span><span>Errors</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-996986791%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-set-passport-data-errors/index.html">SetPassportDataErrors</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>user<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#-903043045%2FClasslikes%2F-1982836883">UserId</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>errors<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><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.passport/-passport-element-error/index.html">PassportElementError</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1235663711%2FClasslikes%2F-1982836883" anchor-label="StopPoll" id="1235663711%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-stop-poll/index.html"><span>Stop</span><wbr></wbr><span><span>Poll</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1235663711%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-stop-poll/index.html">StopPoll</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>chatId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/-chat-identifier/index.html">ChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>messageId<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types/index.html#469798271%2FClasslikes%2F-1982836883">MessageId</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>replyMarkup<span class="token operator">: </span><a href="../dev.inmo.tgbotapi.types.buttons/-inline-keyboard-markup/index.html">InlineKeyboardMarkup</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span> : <a href="../dev.inmo.tgbotapi.abstracts.types/-message-action/index.html">MessageAction</a>, <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../dev.inmo.tgbotapi.types.polls/-poll/index.html">Poll</a><span class="token operator">&gt; </span>, <a href="../dev.inmo.tgbotapi.abstracts.types/-with-reply-markup/index.html">WithReplyMarkup</a></div></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>