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 » More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<KeyboardButtonRequestUsers>

Public Attributes
std::int32_t	requestId { }
	Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message.
std::optional< bool >	userIsBot { }
	Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.
std::optional< bool >	userIsPremium { }
	Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.
std::optional< std::int32_t >	maxQuantity { }
	Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
std::optional< bool >	requestName { }
	Optional. Pass True to request the users' first and last names.
std::optional< bool >	requestUsername { }
	Optional. Pass True to request the users' usernames.
std::optional< bool >	requestPhoto { }
	Optional. Pass True to request the users' photos.

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 8434 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::KeyboardButtonRequestUsers::Ptr = std::shared_ptr<KeyboardButtonRequestUsers>

Definition at line 8435 of file Types.h.

Member Data Documentation

◆ maxQuantity

std::optional<std::int32_t> TgBot::KeyboardButtonRequestUsers::maxQuantity { }

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

Definition at line 8458 of file Types.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 8441 of file Types.h.

◆ requestName

std::optional<bool> TgBot::KeyboardButtonRequestUsers::requestName { }

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

Definition at line 8463 of file Types.h.

◆ requestPhoto

std::optional<bool> TgBot::KeyboardButtonRequestUsers::requestPhoto { }

Optional. Pass True to request the users' photos.

Definition at line 8473 of file Types.h.

◆ requestUsername

std::optional<bool> TgBot::KeyboardButtonRequestUsers::requestUsername { }

Optional. Pass True to request the users' usernames.

Definition at line 8468 of file Types.h.

◆ userIsBot

std::optional<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 8447 of file Types.h.

◆ userIsPremium

std::optional<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 8453 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes