simbot-component-telegram-api/love.forte.simbot.telegram.api/SimpleBodyTelegramApi

SimpleBodyTelegramApi

abstract class SimpleBodyTelegramApi<R : Any> : TelegramApi<R> (source)

An ordinary extensible TelegramApi. Post is used if body is not null, application/json is used if body is not MultiPartFormDataContent, and application/x-www-form-urlencoded is used otherwise.

If body is OutgoingContent other than MultiPartFormDataContent, remember to override headers to provide the necessary information as needed.

Inheritors

Constructors

SimpleBodyTelegramApi

constructor()

Inherited properties

body

abstract val body: Any?

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.

name

abstract val name: String

The method name.

responseDeserializer

abstract val responseDeserializer: DeserializationStrategy<R>

The result's DeserializationStrategy of this Method.

resultDeserializer

abstract val resultDeserializer: DeserializationStrategy<TelegramApiResult<R>>

The TelegramApiResult's DeserializationStrategy of this Method.

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.