This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ». More...

#include <Types.h>

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

Public Attributes
std::int32_t	requestId { }
	Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message.
bool	chatIsChannel { }
	Pass True to request a channel chat, pass False to request a group or a supergroup chat.
std::optional< bool >	chatIsForum { }
	Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
std::optional< bool >	chatHasUsername { }
	Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.
std::optional< bool >	chatIsCreated { }
	Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
std::shared_ptr< ChatAdministratorRights >	userAdministratorRights { }
	Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.
std::shared_ptr< ChatAdministratorRights >	botAdministratorRights { }
	Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.
std::optional< bool >	botIsMember { }
	Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
std::optional< bool >	requestTitle { }
	Optional. Pass True to request the chat's title.
std::optional< bool >	requestUsername { }
	Optional. Pass True to request the chat's username.
std::optional< bool >	requestPhoto { }
	Optional. Pass True to request the chat's photo.

Detailed Description

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».

Definition at line 8328 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 8329 of file Types.h.

Member Data Documentation

◆ botAdministratorRights

std::shared_ptr<ChatAdministratorRights> TgBot::KeyboardButtonRequestChat::botAdministratorRights { }

Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.

Definition at line 8373 of file Types.h.

◆ botIsMember

std::optional<bool> TgBot::KeyboardButtonRequestChat::botIsMember { }

Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.

Definition at line 8379 of file Types.h.

◆ chatHasUsername

std::optional<bool> TgBot::KeyboardButtonRequestChat::chatHasUsername { }

Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.

Definition at line 8353 of file Types.h.

◆ chatIsChannel

bool TgBot::KeyboardButtonRequestChat::chatIsChannel { }

Pass True to request a channel chat, pass False to request a group or a supergroup chat.

Definition at line 8340 of file Types.h.

◆ chatIsCreated

std::optional<bool> TgBot::KeyboardButtonRequestChat::chatIsCreated { }

Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.

Definition at line 8359 of file Types.h.

◆ chatIsForum

std::optional<bool> TgBot::KeyboardButtonRequestChat::chatIsForum { }

Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.

Definition at line 8346 of file Types.h.

◆ requestId

std::int32_t TgBot::KeyboardButtonRequestChat::requestId { }

Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message.

Definition at line 8335 of file Types.h.

◆ requestPhoto

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

Optional. Pass True to request the chat's photo.

Definition at line 8394 of file Types.h.

◆ requestTitle

std::optional<bool> TgBot::KeyboardButtonRequestChat::requestTitle { }

Optional. Pass True to request the chat's title.

Definition at line 8384 of file Types.h.

◆ requestUsername

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

Optional. Pass True to request the chat's username.

Definition at line 8389 of file Types.h.

◆ userAdministratorRights

std::shared_ptr<ChatAdministratorRights> TgBot::KeyboardButtonRequestChat::userAdministratorRights { }

Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.

Definition at line 8366 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes