Contains information about 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 for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

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

std::string	email
	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 for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

PassportFile::Ptr	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.

PassportFile::Ptr	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.

PassportFile::Ptr	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.

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. Files can be decrypted and verified using the accompanying EncryptedCredentials.

std::string	hash
	Base64-encoded element hash for using in PassportElementErrorUnspecified.

Detailed Description

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

Definition at line 17 of file EncryptedPassportElement.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 20 of file EncryptedPassportElement.h.

Member Data Documentation

◆ data

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

◆ email

std::string TgBot::EncryptedPassportElement::email

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

Definition at line 42 of file EncryptedPassportElement.h.

◆ files

std::vector<PassportFile::Ptr> TgBot::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 48 of file EncryptedPassportElement.h.

◆ frontSide

PassportFile::Ptr TgBot::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 55 of file EncryptedPassportElement.h.

◆ hash

std::string TgBot::EncryptedPassportElement::hash

Base64-encoded element hash for using in PassportElementErrorUnspecified.

Definition at line 80 of file EncryptedPassportElement.h.

◆ phoneNumber

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.

◆ reverseSide

PassportFile::Ptr TgBot::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 62 of file EncryptedPassportElement.h.

◆ selfie

PassportFile::Ptr TgBot::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 68 of file EncryptedPassportElement.h.

◆ translation

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 75 of file EncryptedPassportElement.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 26 of file EncryptedPassportElement.h.

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

include/tgbot/types/EncryptedPassportElement.h

Public Types

Public Attributes