simbot-component-telegram-type/love.forte.simbot.telegram.type/KeyboardButtonRequestUsers

KeyboardButtonRequestUsers

@Serializable
data class KeyboardButtonRequestUsers(val requestId: Int, val userIsBot: Boolean? = null, val userIsPremium: Boolean? = null, val maxQuantity: Int? = null)(source)

KeyboardButtonRequestUsers

This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »

(auto-generated)

Author

ForteScarlet

Constructors

Link copied to clipboard
constructor(requestId: Int, userIsBot: Boolean? = null, userIsPremium: Boolean? = null, maxQuantity: Int? = null)

Properties

Link copied to clipboard
@SerialName(value = "max_quantity")
val maxQuantity: Int? = null

Optional. The maximum number of users to be selected; 1-10. Defaults to 1.

Link copied to clipboard
@SerialName(value = "request_id")
val requestId: Int

Signed 32-bit identifier of the request that will be received back in the UsersShared object.

Link copied to clipboard
@SerialName(value = "user_is_bot")
val userIsBot: Boolean? = null

Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.

Link copied to clipboard
@SerialName(value = "user_is_premium")
val userIsPremium: Boolean? = null

Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.