Class: TD::Types::KeyboardButtonType::RequestUsers

Inherits:
TD::Types::KeyboardButtonType show all
Defined in:
lib/tdlib/types/keyboard_button_type/request_users.rb

Overview

A button that requests users to be shared by the current user; available only in private chats. Use the method shareUsersWithBot to complete the request.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#id ⇒ Integer

Unique button identifier.

Returns:

  • (Integer) —

    the current value of id



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def id
  @id
end

#max_quantity ⇒ Integer

The maximum number of users to share.

Returns:

  • (Integer) —

    the current value of max_quantity



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def max_quantity
  @max_quantity
end

#request_name ⇒ Boolean

Pass true to request name of the users; bots only.

Returns:

  • (Boolean) —

    the current value of request_name



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def request_name
  @request_name
end

#request_photo ⇒ Boolean

Pass true to request photo of the users; bots only.

Returns:

  • (Boolean) —

    the current value of request_photo



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def request_photo
  @request_photo
end

#request_username ⇒ Boolean

Pass true to request username of the users; bots only.

Returns:

  • (Boolean) —

    the current value of request_username



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def request_username
  @request_username
end

#restrict_user_is_bot ⇒ Boolean

True, if the shared users must or must not be bots.

Returns:

  • (Boolean) —

    the current value of restrict_user_is_bot



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def restrict_user_is_bot
  @restrict_user_is_bot
end

#restrict_user_is_premium ⇒ Boolean

True, if the shared users must or must not be Telegram Premium users.

Returns:

  • (Boolean) —

    the current value of restrict_user_is_premium



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def restrict_user_is_premium
  @restrict_user_is_premium
end

#user_is_bot ⇒ Boolean

True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false.

Returns:

  • (Boolean) —

    the current value of user_is_bot



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def user_is_bot
  @user_is_bot
end

#user_is_premium ⇒ Boolean

True, if the shared users must be Telegram Premium users; otherwise, the shared users must not be Telegram Premium users. Ignored if restrict_user_is_premium is false.

Returns:

  • (Boolean) —

    the current value of user_is_premium



17
18
19
 
# File 'lib/tdlib/types/keyboard_button_type/request_users.rb', line 17

def user_is_premium
  @user_is_premium
end