List of all members | Public Fields | Public Instance Methods | Static Public Attributes
keyboardButtonTypeRequestUsers Class Referencefinal

Inherits KeyboardButtonType.

Description

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.

Public Fields

int32 id_
 Unique button identifier.
 
bool restrict_user_is_bot_
 True, if the shared users must or must not be bots.
 
bool user_is_bot_
 True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false.
 
bool restrict_user_is_premium_
 True, if the shared users must or must not be Telegram Premium users.
 
bool user_is_premium_
 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.
 
int32 max_quantity_
 The maximum number of users to share.
 
bool request_name_
 Pass true to request name of the users; bots only.
 
bool request_username_
 Pass true to request username of the users; bots only.
 
bool request_photo_
 Pass true to request photo of the users; bots only.
 

Public Instance Methods

 keyboardButtonTypeRequestUsers ()
 
 keyboardButtonTypeRequestUsers (int32 id_, bool restrict_user_is_bot_, bool user_is_bot_, bool restrict_user_is_premium_, bool user_is_premium_, int32 max_quantity_, bool request_name_, bool request_username_, bool request_photo_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -1738765315
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ keyboardButtonTypeRequestUsers() [1/2]

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.

◆ keyboardButtonTypeRequestUsers() [2/2]

keyboardButtonTypeRequestUsers ( int32  id_,
bool  restrict_user_is_bot_,
bool  user_is_bot_,
bool  restrict_user_is_premium_,
bool  user_is_premium_,
int32  max_quantity_,
bool  request_name_,
bool  request_username_,
bool  request_photo_ 
)

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.

Parameters
[in]id_Unique button identifier.
[in]restrict_user_is_bot_True, if the shared users must or must not be bots.
[in]user_is_bot_True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false.
[in]restrict_user_is_premium_True, if the shared users must or must not be Telegram Premium users.
[in]user_is_premium_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.
[in]max_quantity_The maximum number of users to share.
[in]request_name_Pass true to request name of the users; bots only.
[in]request_username_Pass true to request username of the users; bots only.
[in]request_photo_Pass true to request photo of the users; bots only.

Method Documentation

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: