tgbotxx  1.1.6.9
Telegram Bot C++ Library
Public Member Functions | Public Attributes | List of all members
tgbotxx::EncryptedPassportElement Struct Reference

Describes documents or other Telegram Passport elements shared with the bot by the user. https://core.telegram.org/bots/api#encryptedpassportelement. More...

#include <EncryptedPassportElement.hpp>

Public Member Functions

 EncryptedPassportElement ()=default
 
 EncryptedPassportElement (const nl::json &json)
 
nl::json toJson () const
 Serializes this object to JSON. More...
 
void fromJson (const nl::json &json)
 Deserializes this object from JSON. More...
 

Public Attributes

std::string type
 Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”. More...
 
std::string data
 Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
std::string phoneNumber
 Optional. User's verified phone number, available only for “phone_number” type. More...
 
std::string email
 Optional. User's verified email address, available only for “email” type. More...
 
std::vector< Ptr< PassportFile > > files
 Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
Ptr< PassportFile > frontSide
 Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
Ptr< PassportFile > reverseSide
 Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
Ptr< PassportFile > selfie
 Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
std::vector< Ptr< PassportFile > > translation
 Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. More...
 
std::string hash
 Base64-encoded element hash for using in PassportElementErrorUnspecified. More...
 

Detailed Description

Describes documents or other Telegram Passport elements shared with the bot by the user. https://core.telegram.org/bots/api#encryptedpassportelement.

Definition at line 8 of file EncryptedPassportElement.hpp.

Constructor & Destructor Documentation

◆ EncryptedPassportElement() [1/2]

tgbotxx::EncryptedPassportElement::EncryptedPassportElement ( )
default

◆ EncryptedPassportElement() [2/2]

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

Definition at line 10 of file EncryptedPassportElement.hpp.

Member Function Documentation

◆ fromJson()

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

Deserializes this object from JSON.

Definition at line 77 of file EncryptedPassportElement.hpp.

◆ toJson()

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

Serializes this object to JSON.

Returns
JSON representation of this object

Definition at line 61 of file EncryptedPassportElement.hpp.

Member Data Documentation

◆ data

std::string tgbotxx::EncryptedPassportElement::data

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 23 of file EncryptedPassportElement.hpp.

◆ email

std::string tgbotxx::EncryptedPassportElement::email

Optional. User's verified email address, available only for “email” type.

Definition at line 29 of file EncryptedPassportElement.hpp.

◆ files

std::vector<Ptr<PassportFile> > tgbotxx::EncryptedPassportElement::files

Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 34 of file EncryptedPassportElement.hpp.

◆ frontSide

Ptr<PassportFile> tgbotxx::EncryptedPassportElement::frontSide

Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 39 of file EncryptedPassportElement.hpp.

◆ hash

std::string tgbotxx::EncryptedPassportElement::hash

Base64-encoded element hash for using in PassportElementErrorUnspecified.

Definition at line 56 of file EncryptedPassportElement.hpp.

◆ phoneNumber

std::string tgbotxx::EncryptedPassportElement::phoneNumber

Optional. User's verified phone number, available only for “phone_number” type.

Definition at line 26 of file EncryptedPassportElement.hpp.

◆ reverseSide

Ptr<PassportFile> tgbotxx::EncryptedPassportElement::reverseSide

Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 43 of file EncryptedPassportElement.hpp.

◆ selfie

Ptr<PassportFile> tgbotxx::EncryptedPassportElement::selfie

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 47 of file EncryptedPassportElement.hpp.

◆ translation

std::vector<Ptr<PassportFile> > tgbotxx::EncryptedPassportElement::translation

Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

Definition at line 53 of file EncryptedPassportElement.hpp.

◆ type

std::string tgbotxx::EncryptedPassportElement::type

Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

Definition at line 18 of file EncryptedPassportElement.hpp.

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