class Tourmaline::EncryptedPassportElement
- Tourmaline::EncryptedPassportElement
- Reference
- Object
Overview
Describes documents or other Telegram Passport elements shared with the bot by the user.
Included Modules
- JSON::Serializable
Defined in:
tourmaline/types/api.crConstructors
- .new(type : String, hash : String, data : String | Nil = nil, phone_number : String | Nil = nil, email : String | Nil = nil, files : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile, front_side : Tourmaline::PassportFile | Nil = nil, reverse_side : Tourmaline::PassportFile | Nil = nil, selfie : Tourmaline::PassportFile | Nil = nil, translation : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#data : String | Nil
Optional.
-
#data=(data : String | Nil)
Optional.
-
#email : String | Nil
Optional.
-
#email=(email : String | Nil)
Optional.
-
#files : Array(Tourmaline::PassportFile)
Optional.
-
#files=(files : Array(Tourmaline::PassportFile))
Optional.
-
#front_side : Tourmaline::PassportFile | Nil
Optional.
-
#front_side=(front_side : Tourmaline::PassportFile | Nil)
Optional.
-
#hash : String
Base64-encoded element hash for using in PassportElementErrorUnspecified
-
#hash=(hash : String)
Base64-encoded element hash for using in PassportElementErrorUnspecified
-
#phone_number : String | Nil
Optional.
-
#phone_number=(phone_number : String | Nil)
Optional.
-
#reverse_side : Tourmaline::PassportFile | Nil
Optional.
-
#reverse_side=(reverse_side : Tourmaline::PassportFile | Nil)
Optional.
-
#selfie : Tourmaline::PassportFile | Nil
Optional.
-
#selfie=(selfie : Tourmaline::PassportFile | Nil)
Optional.
-
#translation : Array(Tourmaline::PassportFile)
Optional.
-
#translation=(translation : Array(Tourmaline::PassportFile))
Optional.
-
#type : String
Element type.
-
#type=(type : String)
Element type.
Constructor Detail
Instance Method Detail
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.
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.
Optional. User's verified email address, available only for "email" type
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.
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.
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.
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.
Optional. User's verified phone number, available only for "phone_number" type
Optional. User's verified phone number, available only for "phone_number" type
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.
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.
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.
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.
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.
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.
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".
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".