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

#include <KeyboardButtonRequestChat.h>

Public Types
typedef std::shared_ptr< KeyboardButtonRequestChat >	Ptr

Public Attributes
std::int32_t	requestId
	Signed 32-bit identifier of the request, which will be received back in the ChatShared object.

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

bool	chatIsForum
	Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat.

bool	chatHasUsername
	Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username.

bool	chatIsCreated
	Optional. Pass True to request a chat owned by the user.

ChatAdministratorRights::Ptr	userAdministratorRights
	Optional. A JSON-serialized object listing the required administrator rights of the user in the chat.

ChatAdministratorRights::Ptr	botAdministratorRights
	Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat.

bool	botIsMember
	Optional. Pass True to request a chat with the bot as a member.

Detailed Description

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

Definition at line 17 of file KeyboardButtonRequestChat.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 20 of file KeyboardButtonRequestChat.h.

Member Data Documentation

◆ botAdministratorRights

ChatAdministratorRights::Ptr 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 69 of file KeyboardButtonRequestChat.h.

◆ botIsMember

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 76 of file KeyboardButtonRequestChat.h.

◆ chatHasUsername

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 46 of file KeyboardButtonRequestChat.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 32 of file KeyboardButtonRequestChat.h.

◆ chatIsCreated

bool TgBot::KeyboardButtonRequestChat::chatIsCreated

Optional. Pass True to request a chat owned by the user.

Otherwise, no additional restrictions are applied.

Definition at line 53 of file KeyboardButtonRequestChat.h.

◆ chatIsForum

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 39 of file KeyboardButtonRequestChat.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 27 of file KeyboardButtonRequestChat.h.

◆ userAdministratorRights

ChatAdministratorRights::Ptr 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 61 of file KeyboardButtonRequestChat.h.

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

include/tgbot/types/KeyboardButtonRequestChat.h

Public Types

Public Attributes