class Tourmaline::KeyboardButtonRequestUsers

Overview

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

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(request_id : Int32 | Int64, user_is_bot : Bool | Nil = nil, user_is_premium : Bool | Nil = nil, max_quantity : Int32 | Int64 | Nil = nil) #

[View source]

Instance Method Detail

def max_quantity : Int32 | Int64 | Nil #

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


[View source]
def max_quantity=(max_quantity : Int32 | Int64 | Nil) #

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


[View source]
def 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]
def 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]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]