class Tourmaline::EncryptedPassportElement
inherits Reference

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

Included modules

JSON::Serializable

Constructors

.new(type, hash, data : String? = nil, phone_number : String? = nil, email : String? = nil, files : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile, front_side : Tourmaline::PassportFile? = nil, reverse_side : Tourmaline::PassportFile? = nil, selfie : Tourmaline::PassportFile? = nil, translation : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile)

View source

.new(pull : JSON::PullParser)

View source

Methods

#data : String?

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.

View source

#data=(data : String?)

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.

View source

#email : String?

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

View source

#email=(email : String?)

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

View source

#files : Array(Tourmaline::PassportFile)

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.

View source

#files=(files : Array(Tourmaline::PassportFile))

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.

View source

#front_side : Tourmaline::PassportFile?

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.

View source

#front_side=(front_side : Tourmaline::PassportFile?)

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.

View source

#hash : String

Base64-encoded element hash for using in PassportElementErrorUnspecified

View source

#hash=(hash : String)

Base64-encoded element hash for using in PassportElementErrorUnspecified

View source

#phone_number : String?

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

View source

#phone_number=(phone_number : String?)

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

View source

#reverse_side : Tourmaline::PassportFile?

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.

View source

#reverse_side=(reverse_side : Tourmaline::PassportFile?)

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.

View source

#selfie : Tourmaline::PassportFile?

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.

View source

#selfie=(selfie : Tourmaline::PassportFile?)

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.

View source

#translation : Array(Tourmaline::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.

View source

#translation=(translation : Array(Tourmaline::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.

View source

#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".

View source

#type=(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".

View source