TgBot::KeyboardButtonRequestUser Class Reference

This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More...

#include <KeyboardButtonRequestUser.h>

Public Types
typedef std::shared_ptr< KeyboardButtonRequestUser >	Ptr

Public Attributes
std::int32_t	requestId
	Signed 32-bit identifier of the request, which will be received back in the UserShared object.
bool	userIsBot
	Optional. Pass True to request a bot, pass False to request a regular user.
bool	userIsPremium
	Optional. Pass True to request a premium user, pass False to request a non-premium user.

Detailed Description

This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.

Definition at line 15 of file KeyboardButtonRequestUser.h.

Member Typedef Documentation

Ptr

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

Definition at line 18 of file KeyboardButtonRequestUser.h.

Member Data Documentation

requestId

std::int32_t TgBot::KeyboardButtonRequestUser::requestId

Signed 32-bit identifier of the request, which will be received back in the UserShared object.

Must be unique within the message

Definition at line 25 of file KeyboardButtonRequestUser.h.

userIsBot

bool TgBot::KeyboardButtonRequestUser::userIsBot

Optional. Pass True to request a bot, pass False to request a regular user.

If not specified, no additional restrictions are applied.

Definition at line 32 of file KeyboardButtonRequestUser.h.

userIsPremium

bool TgBot::KeyboardButtonRequestUser::userIsPremium

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

If not specified, no additional restrictions are applied.

Definition at line 39 of file KeyboardButtonRequestUser.h.

---

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

• include/tgbot/types/KeyboardButtonRequestUser.h