simbot-component-telegram-api/love.forte.simbot.telegram.api.bot.command/DeleteMyCommandsApi

DeleteMyCommandsApi

class DeleteMyCommandsApi : SimpleBodyTelegramApi<Boolean> (source)

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Author

ForteScarlet

Types

Body

@Serializable

data class Body(val scope: BotCommandScope? = null, val languageCode: String? = null)

Request body for DeleteMyCommandsApi

Factory

object Factory

Properties

body

open override val body: Any

The request body (or null).

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

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.