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

Package-level declarations

The Telegram API and Telegram methods.

Types

EmptyBodyTelegramApi

abstract class EmptyBodyTelegramApi<R : Any> : TelegramApi<R>

body is always null TelegramApi. Will use a GET request directly.

FormBodyTelegramApi

abstract class FormBodyTelegramApi<R : Any> : SimpleBodyTelegramApi<R>

A SimpleBodyTelegramApi whose body is explicitly MultiPartFormDataContent.

ResponseParameters

@Serializable

data class ResponseParameters(val migrateToChatId: Long? = null, val retryAfter: Int? = null)

Describes why a request was unsuccessful.

SimpleBodyTelegramApi

abstract class SimpleBodyTelegramApi<R : Any> : TelegramApi<R>

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.

object Telegram

TelegramApi

sealed class TelegramApi<R : Any>

A Telegram Method.

TelegramApiException

open class TelegramApiException(message: String? = null, cause: Throwable? = null) : RuntimeException

TelegramApiResult

@Serializable

data class TelegramApiResult<T : Any>(val ok: Boolean, val result: T? = null, val description: String? = null, val errorCode: Int? = null, val parameters: ResponseParameters? = null)

The Telegram API response data.

TelegramApiResultNotOkException

open class TelegramApiResultNotOkException(val result: TelegramApiResult<*>, message: String? = "result: ", cause: Throwable? = null) : TelegramApiException

UnknownUpdatedFieldException

class UnknownUpdatedFieldException(message: String? = "Unknown updated field") : IllegalArgumentException

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.

resultOrThrow

fun <T : Any> TelegramApiResult<T>.resultOrThrow(): T

Get TelegramApiResult.result, or throw TelegramApiResultNotOkException if TelegramApiResult.ok = false or TelegramApiResult.result is null.