tgbot-cpp
Loading...
Searching...
No Matches
TgBot::EncryptedPassportElement Struct Reference

Describes documents or other Telegram Passport elements shared with the bot by the user. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<EncryptedPassportElement>

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

Detailed Description

Describes documents or other Telegram Passport elements shared with the bot by the user.

Definition at line 3161 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 3162 of file Types.h.

Member Data Documentation

◆ data

std::optional<std::string> TgBot::EncryptedPassportElement::data { }

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only 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 3176 of file Types.h.

◆ email

std::optional<std::string> TgBot::EncryptedPassportElement::email { }

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

Definition at line 3184 of file Types.h.

◆ files

std::optional<std::vector<std::shared_ptr<PassportFile> > > TgBot::EncryptedPassportElement::files { }

Optional. Array of encrypted files with documents provided by the user; available only 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 3191 of file Types.h.

◆ frontSide

std::shared_ptr<PassportFile> TgBot::EncryptedPassportElement::frontSide { }

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

Definition at line 3198 of file Types.h.

◆ hash

std::string TgBot::EncryptedPassportElement::hash { }

Base64-encoded element hash for using in PassportElementErrorUnspecified.

Definition at line 3223 of file Types.h.

◆ phoneNumber

std::optional<std::string> TgBot::EncryptedPassportElement::phoneNumber { }

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

Definition at line 3180 of file Types.h.

◆ reverseSide

std::shared_ptr<PassportFile> TgBot::EncryptedPassportElement::reverseSide { }

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

Definition at line 3204 of file Types.h.

◆ selfie

std::shared_ptr<PassportFile> TgBot::EncryptedPassportElement::selfie { }

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

Definition at line 3211 of file Types.h.

◆ translation

std::optional<std::vector<std::shared_ptr<PassportFile> > > TgBot::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 3219 of file Types.h.

◆ type

std::string TgBot::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 3169 of file Types.h.


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