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.requests.webhook< / title >
< link href = "../../images/logo-icon.svg" rel = "icon" type = "image/svg" > < script > var pathToRoot = "../../" ; < / script > < script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
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.core: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.core::dev.inmo.tgbotapi.requests.webhook////PointingToDeclaration//789214110" >
< div class = "breadcrumbs" > < a href = "../index.html" > tgbotapi.core< / a > < span class = "delimiter" > /< / span > < span class = "current" > dev.inmo.tgbotapi.requests.webhook< / 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 > < / div >
< div class = "tabs-section-body" >
< div data-togglable = "TYPE" >
< h2 class = "" > Types< / h2 >
< div class = "table" > < a data-name = "-98736851%2FClasslikes%2F789214110" anchor-label = "DeleteWebhook" id = "-98736851%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-delete-webhook/index.html" > < span > Delete< / span > < wbr > < span > < span > Webhook< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-98736851%2FClasslikes%2F789214110" > < / 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.core: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" > class < / span > < a href = "-delete-webhook/index.html" > DeleteWebhook< / a > : < a href = "../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html" > SimpleRequest< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1445333062%2FClasslikes%2F789214110" anchor-label = "GetWebhookInfo" id = "-1445333062%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-get-webhook-info/index.html" > < span > Get< / span > < wbr > < span > Webhook< / span > < wbr > < span > < span > Info< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1445333062%2FClasslikes%2F789214110" > < / 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.core: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" > class < / span > < a href = "-get-webhook-info/index.html" > GetWebhookInfo< / a > : < a href = "../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html" > SimpleRequest< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../dev.inmo.tgbotapi.types/-webhook-info/index.html" > WebhookInfo< / a > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "1188896091%2FClasslikes%2F789214110" anchor-label = "MultipartSetWebhookRequest" id = "1188896091%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-multipart-set-webhook-request/index.html" > < span > Multipart< / span > < wbr > < span > Set< / span > < wbr > < span > Webhook< / span > < wbr > < span > < span > Request< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1188896091%2FClasslikes%2F789214110" > < / 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.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > class < / span > < a href = "-multipart-set-webhook-request/index.html" > MultipartSetWebhookRequest< / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > url< 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 " > certificate< span class = "token operator" > : < / span > < a href = "../dev.inmo.tgbotapi.requests.abstracts/-multipart-file/index.html" > MultipartFile< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > ipAddress< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > maxAllowedConnections< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > allowedUpdates< 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 class = "token punctuation" > , < / span > < / span > < span class = "parameter " > dropPendingUpdates< 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 " > secretToken< 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 > < span class = "token operator" > = < / span > null< / span > < / span > < span class = "token punctuation" > )< / span > : < a href = "-set-webhook-request/index.html" > SetWebhookRequest< / a > , < a href = "../dev.inmo.tgbotapi.requests.abstracts/-multipart-request/index.html" > MultipartRequest< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1578447532%2FClasslikes%2F789214110" anchor-label = "SetWebhook" id = "-1578447532%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-set-webhook/index.html" > < span > Set< / span > < wbr > < span > < span > Webhook< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1578447532%2FClasslikes%2F789214110" > < / 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.core: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 = "-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 > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > < / 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 >
< / div >
< a data-name = "1190257183%2FClasslikes%2F789214110" anchor-label = "SetWebhookRequest" id = "1190257183%2FClasslikes%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-set-webhook-request/index.html" > < span > Set< / span > < wbr > < span > Webhook< / span > < wbr > < span > < span > Request< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1190257183%2FClasslikes%2F789214110" > < / 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.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > sealed < / span > < span class = "token keyword" > class < / span > < a href = "-set-webhook-request/index.html" > SetWebhookRequest< / a > : < a href = "../dev.inmo.tgbotapi.requests.abstracts/-request/index.html" > Request< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div data-togglable = "FUNCTION" >
< h2 class = "" > Functions< / h2 >
< div class = "table" > < a data-name = "-874354791%2FFunctions%2F789214110" anchor-label = "SetWebhook" id = "-874354791%2FFunctions%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-set-webhook.html" > < span > Set< / span > < wbr > < span > < span > Webhook< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-874354791%2FFunctions%2F789214110" > < / 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.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "-set-webhook.html" > < span class = "token function" > SetWebhook< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > url< 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 " > ipAddress< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > maxAllowedConnections< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > allowedUpdates< 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 class = "token punctuation" > , < / span > < / span > < span class = "parameter " > dropPendingUpdates< 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 " > secretToken< 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 > < span class = "token operator" > = < / span > null< / span > < / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "-set-webhook/index.html" > SetWebhook< / a > < / div > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "-set-webhook.html" > < span class = "token function" > SetWebhook< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > url< 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 " > certificate< span class = "token operator" > : < / span > < a href = "../dev.inmo.tgbotapi.requests.abstracts/-input-file/index.html" > InputFile< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > ipAddress< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > maxAllowedConnections< 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 > < span class = "token operator" > = < / span > null< span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > allowedUpdates< 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" > & gt
< / 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 >
