class Telegram::API::EncryptedPassportElement

Overview

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

Defined in:

telegram/api/generated/types.cr

Constructors

Instance Method Summary

Instance methods inherited from class Telegram::API::Type

==(other) ==, client client

Constructor methods inherited from class Telegram::API::Type

new(pull : JSON::PullParser) new

Constructor Detail

def self.new(type : String, hash : String, data : String | Nil = nil, phone_number : String | Nil = nil, email : String | Nil = nil, front_side : PassportFile | Nil = nil, reverse_side : PassportFile | Nil = nil, selfie : PassportFile | Nil = nil, files : Array(PassportFile) = Array(PassportFile).new, translation : Array(PassportFile) = Array(PassportFile).new) #

[View source]
def self.new(pull : JSON::PullParser) #

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


[View source]

Instance Method Detail

def data : String | Nil #

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.


[View source]
def data=(data : String | Nil) #

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.


[View source]
def email : String | Nil #

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


[View source]
def email=(email : String | Nil) #

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


[View source]
def files : Array(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.


[View source]
def files=(files : Array(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.


[View source]
def front_side : PassportFile | Nil #

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.


[View source]
def front_side=(front_side : PassportFile | Nil) #

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.


[View source]
def hash : String #

Base64-encoded element hash for using in PassportElementErrorUnspecified


[View source]
def hash=(hash : String) #

Base64-encoded element hash for using in PassportElementErrorUnspecified


[View source]
def phone_number : String | Nil #

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


[View source]
def phone_number=(phone_number : String | Nil) #

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


[View source]
def reverse_side : PassportFile | Nil #

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.


[View source]
def reverse_side=(reverse_side : PassportFile | Nil) #

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.


[View source]
def selfie : PassportFile | Nil #

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.


[View source]
def selfie=(selfie : PassportFile | Nil) #

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.


[View source]
def translation : Array(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]
def translation=(translation : Array(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]
def 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]
def 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]