tgbot-cpp
Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
TgBot::KeyboardButtonRequestChat Class Reference
Types

This object defines the criteria used to request a suitable chat. 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.
 
bool requestTitle
 Optional. Pass True to request the chat's title.
 
bool requestUsername
 Optional. Pass True to request the chat's username.
 
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 сhat if appropriate More about requesting chats »

Definition at line 19 of file KeyboardButtonRequestChat.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 22 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 userAdministratorRights. If not specified, no additional restrictions are applied.

Definition at line 71 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 78 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 48 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 34 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 55 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 41 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 29 of file KeyboardButtonRequestChat.h.

◆ requestPhoto

bool TgBot::KeyboardButtonRequestChat::requestPhoto

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

Definition at line 93 of file KeyboardButtonRequestChat.h.

◆ requestTitle

bool TgBot::KeyboardButtonRequestChat::requestTitle

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

Definition at line 83 of file KeyboardButtonRequestChat.h.

◆ requestUsername

bool TgBot::KeyboardButtonRequestChat::requestUsername

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

Definition at line 88 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 botAdministratorRights. If not specified, no additional restrictions are applied.

Definition at line 63 of file KeyboardButtonRequestChat.h.

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