EncryptedPassportElement class

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

Constructors

EncryptedPassportElement({required String type, String? data, String? phoneNumber, String? email, List<PassportFile>? files, PassportFile? frontSide, PassportFile? reverseSide, PassportFile? selfie, List<PassportFile>? translation, required String hash})

Basic constructor

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 setter, inherited

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 setter, inherited

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 ↔ String

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”.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map

Creates a json from the object

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(Map<String, dynamic> json) → EncryptedPassportElement

Creates a object from a json

listFromJsonArray(List json) → List<EncryptedPassportElement>

Creates a list of object from a json array