mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-18 14:47:13 +00:00
169 lines
21 KiB
HTML
169 lines
21 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>dev.inmo.tgbotapi.requests.webhook</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.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" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.requests.webhook////PointingToDeclaration//-1982836883">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.requests.webhook</a></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>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Package</span></span> <span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>requests.</span><wbr></wbr><span>webhook</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><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="-98736851%2FClasslikes%2F-1982836883" anchor-label="DeleteWebhook" id="-98736851%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"><a href="-delete-webhook/index.html"><span>Delete</span><wbr></wbr><span><span>Webhook</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-98736851%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">class <a href="-delete-webhook/index.html">DeleteWebhook</a> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1445333062%2FClasslikes%2F-1982836883" anchor-label="GetWebhookInfo" id="-1445333062%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"><a href="-get-webhook-info/index.html"><span>Get</span><wbr></wbr><span>Webhook</span><wbr></wbr><span><span>Info</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1445333062%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">class <a href="-get-webhook-info/index.html">GetWebhookInfo</a> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html">SimpleRequest</a><<a href="../dev.inmo.tgbotapi.types/-webhook-info/index.html">WebhookInfo</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1188896091%2FClasslikes%2F-1982836883" anchor-label="MultipartSetWebhookRequest" id="1188896091%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"><a href="-multipart-set-webhook-request/index.html"><span>Multipart</span><wbr></wbr><span>Set</span><wbr></wbr><span>Webhook</span><wbr></wbr><span><span>Request</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1188896091%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">class <a href="-multipart-set-webhook-request/index.html">MultipartSetWebhookRequest</a>(url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, certificate: <a href="../dev.inmo.tgbotapi.requests.abstracts/-multipart-file/index.html">MultipartFile</a>, ipAddress: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, maxAllowedConnections: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>?, dropPendingUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>?) : <a href="-set-webhook-request/index.html">SetWebhookRequest</a>, <a href="../dev.inmo.tgbotapi.requests.abstracts/-multipart-request/index.html">MultipartRequest</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1578447532%2FClasslikes%2F-1982836883" anchor-label="SetWebhook" id="-1578447532%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"><a href="-set-webhook/index.html"><span>Set</span><wbr></wbr><span><span>Webhook</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1578447532%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">data class <a href="-set-webhook/index.html">SetWebhook</a> : <a href="-set-webhook-request/index.html">SetWebhookRequest</a>, <a href="../dev.inmo.tgbotapi.requests.send.media.base/-data-request/index.html">DataRequest</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<div class="brief "><p class="paragraph">Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update.</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1190257183%2FClasslikes%2F-1982836883" anchor-label="SetWebhookRequest" id="1190257183%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"><a href="-set-webhook-request/index.html"><span>Set</span><wbr></wbr><span>Webhook</span><wbr></wbr><span><span>Request</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1190257183%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">sealed class <a href="-set-webhook-request/index.html">SetWebhookRequest</a> : <a href="../dev.inmo.tgbotapi.requests.abstracts/-request/index.html">Request</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>> <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="573304589%2FFunctions%2F-1982836883" anchor-label="SetWebhook" id="573304589%2FFunctions%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"><a href="-set-webhook.html"><span>Set</span><wbr></wbr><span><span>Webhook</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="573304589%2FFunctions%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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">fun <a href="-set-webhook.html">SetWebhook</a>(url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, ipAddress: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, maxAllowedConnections: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, dropPendingUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>? = null): <a href="-set-webhook/index.html">SetWebhook</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">fun <a href="-set-webhook.html">SetWebhook</a>(url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, certificate: <a href="../dev.inmo.tgbotapi.requests.abstracts/-input-file/index.html">InputFile</a>, ipAddress: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, maxAllowedConnections: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, dropPendingUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>? = null): <a href="-set-webhook-request/index.html">SetWebhookRequest</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<div class="brief "><p class="paragraph">Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update.</p></div></div>
|
|
<div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">fun <a href="-set-webhook.html">SetWebhook</a>(url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, certificate: <a href="../dev.inmo.tgbotapi.requests.abstracts/-file-id/index.html">FileId</a>, ipAddress: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, maxAllowedConnections: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, dropPendingUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>? = null): <a href="-set-webhook/index.html">SetWebhook</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">fun <a href="-set-webhook.html">SetWebhook</a>(url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, certificate: <a href="../dev.inmo.tgbotapi.requests.abstracts/-multipart-file/index.html">MultipartFile</a>, ipAddress: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, maxAllowedConnections: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null, allowedUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>? = null, dropPendingUpdates: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>? = null): <a href="-multipart-set-webhook-request/index.html">MultipartSetWebhookRequest</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>
|
|
|