EncryptedPassportElement class

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

https://core.telegram.org/bots/api#encryptedpassportelement

Annotations
  • @JsonSerializable.new(includeIfNull: false)

Constructors

EncryptedPassportElement({EncryptedPassportElementType? type, String? data, String? phoneNumber, String? email, List<PassportFile>? files, PassportFile? frontSide, PassportFile? reverseSide, PassportFile? selfie, List<PassportFile>? translation, String? hash})
EncryptedPassportElement.fromJson(Map<String, dynamic> json)
factory

Properties

data ↔ String?
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.
getter/setter pair
email ↔ String?
Optional. User's verified email address, available only for “email” type.
getter/setter pair
files ↔ List<PassportFile>?
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.
getter/setter pair
frontSide ↔ PassportFile?
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.
getter/setter pair
hash ↔ String?
Base64-encoded element hash for using in PassportElementErrorUnspecified
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
phoneNumber ↔ String?
Optional. User's verified phone number, available only for “phone_number” type.
getter/setter pair
reverseSide ↔ PassportFile?
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.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selfie ↔ PassportFile?
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.
getter/setter pair
translation ↔ List<PassportFile>?
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.
getter/setter pair
type ↔ EncryptedPassportElementType?
Contains every type of encrypted passport element.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited