2023-03-04 15:25:22 +00:00
|
|
|
<!doctype html>
|
|
|
|
<html>
|
|
|
|
<head>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
|
|
<title>dev.inmo.tgbotapi.extensions.api</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></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></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="navigation-wrapper" id="navigation-wrapper">
|
|
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
|
|
<div class="library-name">
|
|
|
|
<a href="../../index.html">
|
2023-05-19 17:03:00 +00:00
|
|
|
<span>ktgbotapi</span> </a> </div>
|
2023-03-04 15:25:22 +00:00
|
|
|
<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=":tgbotapi.api:dokkaHtmlPartial/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" data-page-type="package" id="content" pageids="tgbotapi.api::dev.inmo.tgbotapi.extensions.api////PointingToDeclaration//378952897">
|
|
|
|
<div class="breadcrumbs"><a href="../index.html">tgbotapi.api</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.extensions.api</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="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button><button class="section-tab" data-togglable="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
|
|
|
|
<div class="tabs-section-body">
|
|
|
|
<div data-togglable="TYPE">
|
|
|
|
<h2 class="">Types</h2>
|
|
|
|
<div class="table"><a data-name="951375368%2FClasslikes%2F378952897" anchor-label="BotBuilder" id="951375368%2FClasslikes%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="-bot-builder/index.html"><span>Bot</span><wbr><span><span>Builder</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="951375368%2FClasslikes%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="-bot-builder/index.html">BotBuilder</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-891347837%2FClasslikes%2F378952897" anchor-label="EditLiveLocationInfo" id="-891347837%2FClasslikes%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="-edit-live-location-info/index.html"><span>Edit</span><wbr><span>Live</span><wbr><span>Location</span><wbr><span><span>Info</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-891347837%2FClasslikes%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/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="-edit-live-location-info/index.html">EditLiveLocationInfo</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>latitude<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>longitude<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>horizontalAccuracy<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</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>heading<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-degrees/index.html">Degrees</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>proximityAlertRadius<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</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>replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/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="../../tgbotapi.core/dev.inmo.tgbotapi.abstracts/-locationed/index.html">Locationed</a>, <a href="../../tgbotapi.core/dev.inmo.tgbotapi.abstracts/-horizontally-accured/index.html">HorizontallyAccured</a>, <a href="../../tgbotapi.core/dev.inmo.tgbotapi.abstracts/-proximity-alertable/index.html">ProximityAlertable</a>, <a href="../../tgbotapi.core/dev.inmo.tgbotapi.abstracts/-headed/index.html">Headed</a>, <a href="../../tgbotapi.core/dev.inmo.tgbotapi.abstracts.types/-with-reply-markup/index.html">WithReplyMarkup</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-1812996086%2FClasslikes%2F378952897" anchor-label="LiveLocationProvider" id="-1812996086%2FClasslikes%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="-live-location-provider/index.html"><span>Live</span><wbr><span>Location</span><wbr><span><span>Provider</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1812996086%2FClasslikes%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-live-location-provider/index.html">LiveLocationProvider</a> : <span data-unresolved-link="io.ktor.utils.io.core/Closeable///PointingToDeclaration/">Closeable</span></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div data-togglable="FUNCTION">
|
|
|
|
<h2 class="">Functions</h2>
|
|
|
|
<div class="table"><a data-name="1335939497%2FFunctions%2F378952897" anchor-label="buildBot" id="1335939497%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="build-bot.html"><span>build</span><wbr><span><span>Bot</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1335939497%2FFunctions%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="build-bot.html"><span class="token function">buildBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">token<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 ">apiUrl<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>telegramBotAPIDefaultUrl<span class="token punctuation">, </span></span><span class="parameter ">testServer<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 ">block<span class="token operator">: </span><span class="token keyword"></span><a href="-bot-builder/index.html">BotBuilder</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-requests-executor/index.html">RequestsExecutor</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-2113971977%2FFunctions%2F378952897" anchor-label="close" id="-2113971977%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="close.html"><span><span>close</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2113971977%2FFunctions%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline 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="close.html"><span class="token function">close</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-1626787711%2FFunctions%2F378952897" anchor-label="delete" id="-1626787711%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="delete.html"><span><span>delete</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1626787711%2FFunctions%2F378952897"></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=":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="delete.html"><span class="token function">delete</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><span class="token punctuation">.</span><a href="delete.html"><span class="token function">delete</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">requestsExecutor<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></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="delete.html"><span class="token function">delete</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 ">messageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></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="delete.html"><span class="token function">delete</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 ">messageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-397926034%2FFunctions%2F378952897" anchor-label="deleteMessage" id="-397926034%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="delete-message.html"><span>delete</span><wbr><span><span>Message</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-397926034%2FFunctions%2F378952897"></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=":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="delete-message.html"><span class="token function">deleteMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></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="delete-message.html"><span class="token function">deleteMessage</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 ">messageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></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="delete-message.html"><span class="token function">deleteMessage</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 ">messageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-2108616335%2FFunctions%2F378952897" anchor-label="forwardMessage" id="-2108616335%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="forward-message.html"><span>forward</span><wbr><span><span>Message</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2108616335%2FFunctions%2F378952897"></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=":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="forward-message.html"><span class="token function">forwardMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">toChatId<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 ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><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>toChatId.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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-possibly-forwarded-message/index.html">PossiblyForwardedMessage</a></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="forward-message.html"><span class="token function">forwardMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">toChat<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 ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><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>toChat.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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-possibly-forwarded-message/index.html">PossiblyForwardedMessage</a></div><div class="symbol mo
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-1598535586%2FFunctions%2F378952897" anchor-label="getUpdates" id="-1598535586%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="get-updates.html"><span>get</span><wbr><span><span>Updates</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1598535586%2FFunctions%2F378952897"></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=":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="get-updates.html"><span class="token function">getUpdates</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">lastUpdate<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token punctuation">, </span></span><span class="parameter ">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 ">timeout<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-seconds/index.html">Seconds</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">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"><</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">></span><span class="token operator">?</span><span class="token operator"> = </span>ALL_UPDATES_LIST</span></span><span class="token punctuation">)</span><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"><</span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html">Update</a><span class="token operator">></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="get-updates.html"><span class="token function">getUpdates</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">offset<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-update-identifier/index.html">UpdateIdentifier</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">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 ">timeout<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-seconds/index.html">Seconds</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">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"><</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">></span><span class="token operator">?</span><span class="token operator"> = </span>ALL_UPDATES_LIST</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/j
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="750100696%2FFunctions%2F378952897" anchor-label="handleLiveLocation" id="750100696%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="handle-live-location.html"><span>handle</span><wbr><span>Live</span><wbr><span><span>Location</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="750100696%2FFunctions%2F378952897"></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=":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="handle-live-location.html"><span class="token function">handleLiveLocation</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 ">locationsFlow<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span class="token keyword"></span><a href="-edit-live-location-info/index.html">EditLiveLocationInfo</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">liveTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>defaultLivePeriodDelayMillis<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 ">replyToMessageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">allowSendingWithoutReply<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 operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">sentMessageFlow<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector///PointingToDeclaration/">FlowCollector</span><span class="token operator"><</span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-content-message/index.html">ContentMessage</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.content/-location-content/index.html">LocationContent</a><span class="token operator">></span><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Will <a href="../dev.inmo.tgbotapi.extensions.api.send/send-live-location.html">sendLiveLocation</a> with the first <a href="-edit-live-location-info/index.html">EditLiveLocationInfo</a> data and update than. Each <a href="
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="999830545%2FFunctions%2F378952897" anchor-label="logOut" id="999830545%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="log-out.html"><span>log</span><wbr><span><span>Out</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="999830545%2FFunctions%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline 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="log-out.html"><span class="token function">logOut</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="49013312%2FFunctions%2F378952897" anchor-label="replyWithLiveLocation" id="49013312%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="reply-with-live-location.html"><span>reply</span><wbr><span>With</span><wbr><span>Live</span><wbr><span><span>Location</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="49013312%2FFunctions%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline 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="reply-with-live-location.html"><span class="token function">replyWithLiveLocation</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">to<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">location<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.location/-static-location/index.html">StaticLocation</a><span class="token punctuation">, </span></span><span class="parameter ">liveTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>defaultLivePeriodDelayMillis<span class="token punctuation">, </span></span><span class="parameter ">initHorizontalAccuracy<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">initHeading<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-degrees/index.html">Degrees</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">initProximityAlertRadius<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</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>to.threadIdOrNull<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 ">allowSendingWithoutReply<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 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="-live-location-provider/index.html">LiveLocation
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-1853550537%2FFunctions%2F378952897" anchor-label="startLiveLocation" id="-1853550537%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="start-live-location.html"><span>start</span><wbr><span>Live</span><wbr><span><span>Location</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1853550537%2FFunctions%2F378952897"></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=":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="start-live-location.html"><span class="token function">startLiveLocation</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">chatId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-id-chat-identifier/index.html">IdChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter ">location<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.location/-static-location/index.html">StaticLocation</a><span class="token punctuation">, </span></span><span class="parameter ">liveTimeMillis<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>defaultLivePeriodDelayMillis<span class="token punctuation">, </span></span><span class="parameter ">initHorizontalAccuracy<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">initHeading<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-degrees/index.html">Degrees</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">initProximityAlertRadius<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-meters/index.html">Meters</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 ">replyToMessageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">allowSendingWithoutReply<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 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
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-760180775%2FFunctions%2F378952897" anchor-label="stopPoll" id="-760180775%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="stop-poll.html"><span>stop</span><wbr><span><span>Poll</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-760180775%2FFunctions%2F378952897"></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=":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="stop-poll.html"><span class="token function">stopPoll</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 ">messageId<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types/-message-id/index.html">MessageId</a><span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/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><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-poll/index.html">Poll</a></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="stop-poll.html"><span class="token function">stopPoll</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/-id-chat-identifier/index.html">IdChatIdentifier</a><span class="token punctuation">, </span></span><span class="parameter ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/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><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-poll/index.html">Poll</a></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="stop-poll.html"><span class="token function">stopPoll</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 ">message<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.message.abstracts/-message/index.html">Message</a><span class="token punctuation">, </span></span><span class="parameter ">replyMarkup<span class="token operator">: </span><a href="../../tgbotapi.core/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><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.types.polls/-poll/index.html">Poll</a></div><div class="symbol monospace"><span class="token keyword">suspend <
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a data-name="-1019260782%2FFunctions%2F378952897" anchor-label="telegramBot" id="-1019260782%2FFunctions%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="telegram-bot.html"><span>telegram</span><wbr><span><span>Bot</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1019260782%2FFunctions%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">urlsKeeper<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">, </span></span><span class="parameter ">client<span class="token operator">: </span><span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span><span class="token operator"> = </span>HttpClient()</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-telegram-bot/index.html">TelegramBot</a></div><div class="brief "><p class="paragraph">Allows to create bot using bot <a href="telegram-bot.html">urlsKeeper</a> and already prepared <a href="telegram-bot.html">client</a></p></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">urlsKeeper<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>clientConfig<span class="token operator">: </span><span class="token keyword"></span><span data-unresolved-link="io.ktor.client/HttpClientConfig///PointingToDeclaration/">HttpClientConfig</span><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.bot/-requests-executor/index.html">RequestsExecutor</a></div><div class="brief "><p class="paragraph">Allows to create bot using bot <a href="telegram-bot.html">urlsKeeper</a> and specify <span data-unresolved-link="io.ktor.client.engine/HttpClientEngine///PointingToDeclaration/">HttpClientEngine</span> by configuring <span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span> using <a href="telegram-bot.html">clientConfig</a></p></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="telegram-bot.html"><span class="token function">telegramBot</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">urlsKeeper<span class="token operator">: </span><a href="../../tgbotapi.core/dev.inmo.tgbotapi.utils/-telegram-a-p-i-urls-keeper/index.html">TelegramAPIUrlsKeeper</a><span class="token punctuation">, </span></span><span class="parameter ">clientEngine<span class="token operator">: </span><span data-unresolved-link="io.ktor.client.engine/HttpClientEngine///PointingToDeclaration/">HttpClientEngine</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>clientConfig<span class="token operator">: </span><span class="token keyword"></span><span data-unresolved-link="io.ktor.client/HttpClientConfig///PointingToDeclaration/">HttpClientConfig</span><span class="token operator
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div data-togglable="PROPERTY">
|
|
|
|
<h2 class="">Properties</h2>
|
|
|
|
<div class="table"><a data-name="-1267462584%2FProperties%2F378952897" anchor-label="defaultLivePeriodDelayMillis" id="-1267462584%2FProperties%2F378952897" data-filterable-set=":tgbotapi.api:dokkaHtmlPartial/commonMain"></a>
|
|
|
|
<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><a href="default-live-period-delay-millis.html"><span>default</span><wbr><span>Live</span><wbr><span>Period</span><wbr><span>Delay</span><wbr><span><span>Millis</span></span></a></div>
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1267462584%2FProperties%2F378952897"></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=":tgbotapi.api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="default-live-period-delay-millis.html">defaultLivePeriodDelayMillis</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div></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>© 2023 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>
|
|
|
|
|