TgBot::KeyboardButtonRequestUsers Class Reference

This object defines the criteria used to request suitable users. More...

#include <KeyboardButtonRequestUsers.h>

Public Types
typedef std::shared_ptr< KeyboardButtonRequestUsers >	Ptr

Public Attributes
std::int32_t	requestId
	Signed 32-bit identifier of the request that will be received back in the UsersShared object.
bool	userIsBot
	Optional. Pass True to request bots, pass False to request regular users.
bool	userIsPremium
	Optional. Pass True to request premium users, pass False to request non-premium users.
std::uint8_t	maxQuantity
	Optional. The maximum number of users to be selected; 1-10.
bool	requestName
	Optional. Pass True to request the users' first and last name.
bool	requestUsername
	Optional. Pass True to request the users' username.
bool	requestPhoto
	Optional. Pass True to request the users' photo.

Detailed Description

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 »

Definition at line 17 of file KeyboardButtonRequestUsers.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<KeyboardButtonRequestUsers> TgBot::KeyboardButtonRequestUsers::Ptr

Definition at line 20 of file KeyboardButtonRequestUsers.h.

Member Data Documentation

maxQuantity

std::uint8_t TgBot::KeyboardButtonRequestUsers::maxQuantity

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

Defaults to 1.

Definition at line 48 of file KeyboardButtonRequestUsers.h.

requestId

std::int32_t TgBot::KeyboardButtonRequestUsers::requestId

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

Must be unique within the message

Definition at line 27 of file KeyboardButtonRequestUsers.h.

requestName

bool TgBot::KeyboardButtonRequestUsers::requestName

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

Definition at line 53 of file KeyboardButtonRequestUsers.h.

requestPhoto

bool TgBot::KeyboardButtonRequestUsers::requestPhoto

Optional. Pass True to request the users' photo.

Definition at line 63 of file KeyboardButtonRequestUsers.h.

requestUsername

bool TgBot::KeyboardButtonRequestUsers::requestUsername

Optional. Pass True to request the users' username.

Definition at line 58 of file KeyboardButtonRequestUsers.h.

userIsBot

bool TgBot::KeyboardButtonRequestUsers::userIsBot

Optional. Pass True to request bots, pass False to request regular users.

If not specified, no additional restrictions are applied.

Definition at line 34 of file KeyboardButtonRequestUsers.h.

userIsPremium

bool TgBot::KeyboardButtonRequestUsers::userIsPremium

Optional. Pass True to request premium users, pass False to request non-premium users.

If not specified, no additional restrictions are applied.

Definition at line 41 of file KeyboardButtonRequestUsers.h.

---

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

• include/tgbot/types/KeyboardButtonRequestUsers.h