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

Body

data class Body(val offset: Int? = null, val limit: Int? = null, val timeout: Int? = null, val allowedUpdates: Collection<String>? = null)(source)

Parameters of GetUpdatesApi

Constructors

Body

constructor(offset: Int? = null, limit: Int? = null, timeout: Int? = null, allowedUpdates: Collection<String>? = null)

Properties

allowedUpdates

@SerialName(value = "allowed_updates")

val allowedUpdates: Collection<String>? = null

Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.

limit

val limit: Int? = null

Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.

offset

val offset: Int? = null

Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.

timeout

val timeout: Int? = null

Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.