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

GetUpdatesApi

class GetUpdatesApi : SimpleBodyTelegramApi<List<Update>> (source)

getUpdates

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Notes

  1. This method will not work if an outgoing webhook is set up.

  2. In order to avoid getting duplicate updates, recalculate offset after each server response.

To create a long polling as a Flow, see getUpdateFlow.

Author

ForteScarlet

See also

Types

Link copied to clipboard
@Serializable
data class Body(val offset: Int? = null, val limit: Int? = null, val timeout: Int? = null, val allowedUpdates: Collection<String>? = null)

Parameters of GetUpdatesApi

Link copied to clipboard
object Factory

Properties

Link copied to clipboard
open override val body: Any

The request body (or null).

Link copied to clipboard
open override val name: String

The method name.

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

The result's DeserializationStrategy of this Method.

Link copied to clipboard

Inherited properties

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.