Skip to content

class Tourmaline::KeyboardButtonRequestUsers
inherits Reference #

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: https://core.telegram.org/bots/features#chat-and-user-selection

Included modules

JSON::Serializable

Constructors#

.new(pull : JSON::PullParser) #

View source

.new(request_id, user_is_bot : Bool? = nil, user_is_premium : Bool? = nil, max_quantity : Int32 | Int64 | Nil = nil) #

View source

Methods#

#max_quantity : Int32 | Int64 | Nil #

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

View source

#max_quantity=(max_quantity : Int32 | Int64 | Nil) #

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

View source

#request_id : Int32 | Int64 #

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

View source

#request_id=(request_id : Int32 | Int64) #

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

View source

#user_is_bot=(user_is_bot : Bool?) #

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

View source

#user_is_bot? : Bool? #

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

View source

#user_is_premium=(user_is_premium : Bool?) #

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

View source

#user_is_premium? : Bool? #

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

View source