tgbotxx  1.1.6.9
Telegram Bot C++ Library
tgbotxx::User Struct Reference

This object represents a Telegram user or bot. https://core.telegram.org/bots/api#user. More...

#include <User.hpp>

Public Member Functions

 User ()=default
 
 User (const nl::json &json)
 
nl::json toJson () const
 
void fromJson (const nl::json &json)
 

Public Attributes

std::int64_t id {}
 Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. More...
 
bool isBot {}
 True, if this user is a bot. More...
 
std::string firstName
 User's or bot's first name. More...
 
std::string lastName
 Optional. User's or bot's last name. More...
 
std::string username
 Optional. User's or bot's username. More...
 
std::string languageCode
 Optional. IETF language tag of the user's language. More...
 
bool isPremium {}
 Optional. True, if this user is a Telegram Premium user. More...
 
bool addedToAttachmentMenu {}
 Optional. True, if this user added the bot to the attachment menu. More...
 
bool canJoinGroups {}
 Optional. True, if the bot can be invited to groups. Returned only in getMe. More...
 
bool canReadAllGroupMessages {}
 Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. More...
 
bool supportsInlineQueries {}
 Optional. True, if the bot supports inline queries. Returned only in getMe. More...
 

Detailed Description

This object represents a Telegram user or bot. https://core.telegram.org/bots/api#user.

Definition at line 7 of file User.hpp.

Constructor & Destructor Documentation

◆ User() [1/2]

tgbotxx::User::User ( )
default

◆ User() [2/2]

tgbotxx::User::User ( const nl::json &  json)
inlineexplicit

Definition at line 9 of file User.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::User::fromJson ( const nl::json &  json)
inline

Definition at line 66 of file User.hpp.

◆ toJson()

nl::json tgbotxx::User::toJson ( ) const
inline

Definition at line 50 of file User.hpp.

Member Data Documentation

◆ addedToAttachmentMenu

bool tgbotxx::User::addedToAttachmentMenu {}

Optional. True, if this user added the bot to the attachment menu.

Definition at line 38 of file User.hpp.

◆ canJoinGroups

bool tgbotxx::User::canJoinGroups {}

Optional. True, if the bot can be invited to groups. Returned only in getMe.

Definition at line 41 of file User.hpp.

◆ canReadAllGroupMessages

bool tgbotxx::User::canReadAllGroupMessages {}

Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

Definition at line 44 of file User.hpp.

◆ firstName

std::string tgbotxx::User::firstName

User's or bot's first name.

Definition at line 23 of file User.hpp.

◆ id

std::int64_t tgbotxx::User::id {}

Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

Definition at line 17 of file User.hpp.

◆ isBot

bool tgbotxx::User::isBot {}

True, if this user is a bot.

Definition at line 20 of file User.hpp.

◆ isPremium

bool tgbotxx::User::isPremium {}

Optional. True, if this user is a Telegram Premium user.

Definition at line 35 of file User.hpp.

◆ languageCode

std::string tgbotxx::User::languageCode

Optional. IETF language tag of the user's language.

Definition at line 32 of file User.hpp.

◆ lastName

std::string tgbotxx::User::lastName

Optional. User's or bot's last name.

Definition at line 26 of file User.hpp.

◆ supportsInlineQueries

bool tgbotxx::User::supportsInlineQueries {}

Optional. True, if the bot supports inline queries. Returned only in getMe.

Definition at line 47 of file User.hpp.

◆ username

std::string tgbotxx::User::username

Optional. User's or bot's username.

Definition at line 29 of file User.hpp.


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