mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-11-26 12:08:43 +00:00
77 lines
21 KiB
HTML
77 lines
21 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>telegramBot</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//telegramBot/#dev.inmo.tgbotapi.utils.TelegramAPIUrlsKeeper#io.ktor.client.HttpClient/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</a><span class="delimiter">/</span><span class="current">telegramBot</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>telegram</span><wbr><span><span>Bot</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"></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><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><hr><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot.html">T</a><span class="token operator"> : </span><span data-unresolved-link="io.ktor.client.engine/HttpClientEngineConfig///PointingToDeclaration/">HttpClientEngineConfig</span><span class="token operator">> </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 ">clientFactory<span class="token operator">: </span><span data-unresolved-link="io.ktor.client.engine/HttpClientEngineFactory///PointingToDeclaration/">HttpClientEngineFactory</span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot.html">T</a><span class="token operator">></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"><</span><span class="token keyword"></span><a href="telegram-bot.html">T</a><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 class="token operator"> = </span>{}</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><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/HttpClientEngineFactory///PointingToDeclaration/">HttpClientEngineFactory</span> by passing <a href="telegram-bot.html">clientFactory</a> param and optionally configure it with <a href="telegram-bot.html">clientConfig</a></p><hr><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"><</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 class="token operator"> = </span>{}</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><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 passing <a href="telegram-bot.html">clientEngine</a> param and optionally configure <span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span> using <a href="telegram-bot.html">clientConfig</a></p><hr><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><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><hr><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 ">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 ">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><p class="paragraph">Allows to create bot using bot <a href="telegram-bot.html">token</a>, <a href="telegram-bot.html">apiUrl</a> (for custom api servers) and already prepared <a href="telegram-bot.html">client</a></p><hr><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot.html">T</a><span class="token operator"> : </span><span data-unresolved-link="io.ktor.client.engine/HttpClientEngineConfig///PointingToDeclaration/">HttpClientEngineConfig</span><span class="token operator">> </span><a href="telegram-bot.html"><span class="token function">telegramBot</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 ">clientFactory<span class="token operator">: </span><span data-unresolved-link="io.ktor.client.engine/HttpClientEngineFactory///PointingToDeclaration/">HttpClientEngineFactory</span><span class="token operator"><</span><span class="token keyword"></span><a href="telegram-bot.html">T</a><span class="token operator">></span><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 "><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 keyword"></span><a href="telegram-bot.html">T</a><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 class="token operator"> = </span>{}</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><br><hr><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 ">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 ">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 ">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 "><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 class="token operator"> = </span>{}</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><p class="paragraph">Allows to create bot using bot <a href="telegram-bot.html">token</a> and specify <span data-unresolved-link="io.ktor.client.engine/HttpClientEngine///PointingToDeclaration/">HttpClientEngine</span> by passing <a href="telegram-bot.html">clientEngine</a> param and optionally configure <span data-unresolved-link="io.ktor.client/HttpClient///PointingToDeclaration/">HttpClient</span> using <a href="telegram-bot.html">clientConfig</a></p><hr><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 ">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 "><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><p class="paragraph">Allows to create bot using bot <a href="telegram-bot.html">token</a> and <a href="telegram-bot.html">apiUrl</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>
|
|
</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>
|
|
|