class Hamilton::Types::KeyboardButtonRequestUsers

Hamilton::Types::KeyboardButtonRequestUsers
Reference
Object

Overview

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.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/keyboard_button_request_user.cr

Constructors

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

Instance Method Summary

#max_quantity : Int32 | Nil
The maximum number of users to be selected; 1-10.
#max_quantity=(max_quantity : Int32 | Nil)
The maximum number of users to be selected; 1-10.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#request_id : Int32
Signed 32-bit identifier of the request that will be received back in the UsersShared object.
#request_id=(request_id : Int32)
Signed 32-bit identifier of the request that will be received back in the UsersShared object.
#request_name : Bool | Nil
Pass True to request the users' first and last names.
#request_name=(request_name : Bool | Nil)
Pass True to request the users' first and last names.
#request_photo : Bool | Nil
Pass True to request the users' photos.
#request_photo=(request_photo : Bool | Nil)
Pass True to request the users' photos.
#request_username : Bool | Nil
Pass True to request the users' usernames.
#request_username=(request_username : Bool | Nil)
Pass True to request the users' usernames.
#user_is_bot : Bool | Nil
Pass True to request bots, pass False to request regular users.
#user_is_bot=(user_is_bot : Bool | Nil)
Pass True to request bots, pass False to request regular users.
#user_is_premium : Bool | Nil
Pass True to request premium users, pass False to request non-premium users.
#user_is_premium=(user_is_premium : Bool | Nil)
Pass True to request premium users, pass False to request non-premium users.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def max_quantity : Int32 | Nil #

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

def max_quantity=(max_quantity : Int32 | Nil) #

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

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def request_id : Int32 #

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

def request_id=(request_id : Int32) #

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

def request_name : Bool | Nil #

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

def request_name=(request_name : Bool | Nil) #

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

def request_photo : Bool | Nil #

Pass True to request the users' photos.

def request_photo=(request_photo : Bool | Nil) #

Pass True to request the users' photos.

def request_username : Bool | Nil #

Pass True to request the users' usernames.

def request_username=(request_username : Bool | Nil) #

Pass True to request the users' usernames.

def user_is_bot : Bool | Nil #

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

def user_is_bot=(user_is_bot : Bool | Nil) #

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

def user_is_premium : Bool | Nil #

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

def user_is_premium=(user_is_premium : Bool | Nil) #