tgbotapi.core/dev.inmo.tgbotapi.requests.webhook

Package-level declarations

Types

Link copied to clipboard
@Serializable
class DeleteWebhook : SimpleRequest<Boolean>
Link copied to clipboard
@Serializable
class GetWebhookInfo : SimpleRequest<WebhookInfo>
Link copied to clipboard
class MultipartSetWebhookRequest(url: String, certificate: MultipartFile, ipAddress: String? = null, maxAllowedConnections: Int? = null, allowedUpdates: List<String>? = ALL_UPDATES_LIST, dropPendingUpdates: Boolean? = null, secretToken: String? = null) : SetWebhookRequest, MultipartRequest<Boolean>
Link copied to clipboard
@Serializable
data class SetWebhook : SetWebhookRequest, DataRequest<Boolean>

Represents a request for setting a webhook in Telegram's Bot API. A webhook allows Telegram to send updates directly to the bot via an HTTPS POST request to the provided URL, enabling real-time interaction.

Link copied to clipboard

Functions

Link copied to clipboard
fun SetWebhook(url: String, ipAddress: String? = null, maxAllowedConnections: Int? = null, allowedUpdates: List<String>? = ALL_UPDATES_LIST, dropPendingUpdates: Boolean? = null, secretToken: String? = null): SetWebhook
fun SetWebhook(url: String, certificate: InputFile, ipAddress: String? = null, maxAllowedConnections: Int? = null, allowedUpdates: List<String>? = ALL_UPDATES_LIST, dropPendingUpdates: Boolean? = null, secretToken: String? = null): SetWebhookRequest

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.

fun SetWebhook(url: String, certificate: FileId, ipAddress: String? = null, maxAllowedConnections: Int? = null, allowedUpdates: List<String>? = ALL_UPDATES_LIST, dropPendingUpdates: Boolean? = null, secretToken: String? = null): SetWebhook
fun SetWebhook(url: String, certificate: MultipartFile, ipAddress: String? = null, maxAllowedConnections: Int? = null, allowedUpdates: List<String>? = ALL_UPDATES_LIST, dropPendingUpdates: Boolean? = null, secretToken: String? = null): MultipartSetWebhookRequest