GetUpdatesRequest

data class GetUpdatesRequest(offset: Int?, limit: Int?, timeout: Int?, allowedUpdates: List<String>)

Request body for getUpdates

Parameters

offset

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 forgotten.

limit

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

timeout

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.

allowedUpdates

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 updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.

Constructors

GetUpdatesRequest
Link copied to clipboard
common
fun GetUpdatesRequest(offset: Int? = null, limit: Int? = null, timeout: Int? = null, allowedUpdates: List<String> = emptyList())
Identifier of the first update to be returned.

Functions

component1
Link copied to clipboard
common
operator fun component1(): Int?
component2
Link copied to clipboard
common
operator fun component2(): Int?
component3
Link copied to clipboard
common
operator fun component3(): Int?
component4
Link copied to clipboard
common
operator fun component4(): List<String>
copy
Link copied to clipboard
common
fun copy(offset: Int? = null, limit: Int? = null, timeout: Int? = null, allowedUpdates: List<String> = emptyList()): GetUpdatesRequest
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

allowedUpdates
Link copied to clipboard
common
val allowedUpdates: List<String>
A JSON-serialized list of the update types you want your bot to receive.
limit
Link copied to clipboard
common
val limit: Int? = null
Limits the number of updates to be retrieved.
offset
Link copied to clipboard
common
val offset: Int? = null
Identifier of the first update to be returned.
timeout
Link copied to clipboard
common
val timeout: Int? = null
Timeout in seconds for long polling.