- Generated on Tue Jun 11 2024 00:46:35 for tgbot-cpp by
1.11.0
|
tgbot-cpp
|
Describes documents or other Telegram Passport elements shared with the bot by the user. More...
#include <EncryptedPassportElement.h>
Public Types | |
| typedef std::shared_ptr< EncryptedPassportElement > | Ptr |
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::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. | |
| std::string | phoneNumber |
| Optional. User's verified phone number; available only for “phone_number” type. | |
| std::string | |
| Optional. User's verified email address; available only for “email” type. | |
| std::vector< PassportFile::Ptr > | 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. | |
| PassportFile::Ptr | 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”. | |
| PassportFile::Ptr | reverseSide |
| Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. | |
| PassportFile::Ptr | 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”. | |
| std::vector< PassportFile::Ptr > | 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. | |
| std::string | hash |
| Base64-encoded element hash for using in PassportElementErrorUnspecified. | |
Describes documents or other Telegram Passport elements shared with the bot by the user.
Definition at line 17 of file EncryptedPassportElement.h.
| typedef std::shared_ptr<EncryptedPassportElement> TgBot::EncryptedPassportElement::Ptr |
Definition at line 20 of file EncryptedPassportElement.h.
| 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 32 of file EncryptedPassportElement.h.
| std::string TgBot::EncryptedPassportElement::email |
Optional. User's verified email address; available only for “email” type.
Definition at line 42 of file EncryptedPassportElement.h.
| std::vector<PassportFile::Ptr> 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 49 of file EncryptedPassportElement.h.
| PassportFile::Ptr 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 56 of file EncryptedPassportElement.h.
| std::string TgBot::EncryptedPassportElement::hash |
Base64-encoded element hash for using in PassportElementErrorUnspecified.
Definition at line 82 of file EncryptedPassportElement.h.
| std::string TgBot::EncryptedPassportElement::phoneNumber |
Optional. User's verified phone number; available only for “phone_number” type.
Definition at line 37 of file EncryptedPassportElement.h.
| PassportFile::Ptr 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 63 of file EncryptedPassportElement.h.
| PassportFile::Ptr 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 70 of file EncryptedPassportElement.h.
| std::vector<PassportFile::Ptr> 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 77 of file EncryptedPassportElement.h.
| 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 25 of file EncryptedPassportElement.h.
1.11.0