simbot-component-telegram-api/love.forte.simbot.telegram.api.bot/CloseApi

CloseApi

class CloseApi : EmptyBodyTelegramApi<Boolean> (source)

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Author

ForteScarlet

Types

Factory

object Factory

Properties

name

open override val name: String

The method name.

responseDeserializer

open override val responseDeserializer: DeserializationStrategy<Boolean>

The result's DeserializationStrategy of this Method.

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<TelegramApiResult<Boolean>>

The TelegramApiResult's DeserializationStrategy of this Method.

Inherited properties

body

override val body: Unit?

The request body (or null).

bodySerializationStrategy

open val bodySerializationStrategy: SerializationStrategy<Any>?

A special deserialization for body. If it is null, then try to 'guess' the body serializer. This is usually overridden when the body is not null and you need to customize its serializer.

headers

open val headers: Headers

Headers for request. Default is Headers.Empty.

Inherited functions

requestData

suspend fun <R : Any> TelegramApi<R>.requestData(client: HttpClient, token: String, server: Url?): R

suspend fun <R : Any> TelegramApi<R>.requestData(client: HttpClient, token: String, server: String? = null): R

Request the TelegramApi by client with token.

requestRaw

suspend fun TelegramApi<*>.requestRaw(client: HttpClient, token: String, server: Url?): HttpResponse

suspend fun TelegramApi<*>.requestRaw(client: HttpClient, token: String, server: String? = null): HttpResponse

Request the TelegramApi by client with token.

requestResult

suspend fun <R : Any> TelegramApi<R>.requestResult(client: HttpClient, token: String, server: Url?): TelegramApiResult<R>

suspend fun <R : Any> TelegramApi<R>.requestResult(client: HttpClient, token: String, server: String? = null): TelegramApiResult<R>

Request the TelegramApi by client with token.