class

Tourmaline::KeyboardButtonRequestUsers

Inherits JSON::Serializable < Reference < Object

This object defines the criteria used to request suitable users. Information about 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

Constructors

new(pull : JSON::PullParser)

new(request_id : Int32 | Int64, user_is_bot : Bool | Nil = nil, user_is_premium : Bool | Nil = nil, max_quantity : Int32 | Int64 | Nil = nil, request_name : Bool | Nil = nil, request_username : Bool | Nil = nil, request_photo : Bool | Nil = nil)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

max_quantity

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

max_quantity=(max_quantity : Int32 | Int64 | Nil)

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

request_id

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

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

request_name=(request_name : Bool | Nil)

Optional. Pass True to request the users' first and last names

request_name?

Optional. Pass True to request the users' first and last names

request_photo=(request_photo : Bool | Nil)

Optional. Pass True to request the users' photos

request_photo?

Optional. Pass True to request the users' photos

request_username=(request_username : Bool | Nil)

Optional. Pass True to request the users' usernames

request_username?

Optional. Pass True to request the users' usernames

user_is_bot=(user_is_bot : Bool | Nil)

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

user_is_bot?

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

user_is_premium=(user_is_premium : Bool | Nil)

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

user_is_premium?

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