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

LogOutApi

class LogOutApi : EmptyBodyTelegramApi<Boolean> (source)

logOut

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Author

ForteScarlet

Types

Link copied to clipboard
object Factory

Properties

Link copied to clipboard
open override val name: String

The method name.

Link copied to clipboard
open override val responseDeserializer: DeserializationStrategy<Boolean>

The result's DeserializationStrategy of this Method.

Link copied to clipboard

Inherited properties

Link copied to clipboard
override val body: Unit?

The request body (or null).

Link copied to clipboard
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.

Link copied to clipboard
open val headers: Headers

Headers for request. Default is Headers.Empty.

Inherited functions

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.