telegramsjs
    Preparing search index...

    Class EncryptedPassportElement

    Hierarchy (View Summary)

    • Base
      • EncryptedPassportElement
    Index

    Constructors

    constructor

    Properties

    data? email? files? frontSide? hash phoneNumber? reverseSide? selfie? translation? type

    Accessors

    client

    Methods

    _clone _patch _update toJSON valueOf

    Constructors

    Properties

    data?: string

    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

    email?: string

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

    files?: ReadonlyCollection<string, InputFile>

    Collection of encrypted files with documents provided by the user; This array is available only for types "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The files can be decrypted and verified using the accompanying EncryptedCredentials

    frontSide?: PassportFile

    Encrypted file with the front side of the document, provided by the user; This file is available only for types "passport", "driver_license", "identity_card", and "internal_passport". It can be decrypted and verified using the accompanying EncryptedCredentials

    hash: string

    Base64-encoded element hash for use in PassportElementErrorUnspecified.

    phoneNumber?: string

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

    reverseSide?: PassportFile

    Encrypted file with the reverse side of the document, provided by the user; This file is available only for types "driver_license" and "identity_card". It can be decrypted and verified using the accompanying EncryptedCredentials

    selfie?: PassportFile

    Encrypted file with the selfie of the user holding a document, provided by the user. This file is available if requested for types "passport", "driver_license", "identity_card", and "internal_passport". It can be decrypted and verified using the accompanying EncryptedCredentials

    translation?: ReadonlyCollection<string, PassportFile>

    Collection of encrypted files with translated versions of documents provided by the user; This array is available only for types "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The files can be decrypted and verified using the accompanying EncryptedCredentials

    type:
        | "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. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", and "email".

    Accessors

    Methods

    Protected_clone

    • _clone(): Base
      Protected

      Creates a clone of the current instance

      Returns Base

      A clone of the current instance

    _patch

    • _patch(data: EncryptedPassportElement): EncryptedPassportElement

      Parameters

      • data: EncryptedPassportElement

        Data about the describes documents or other Telegram Passport elements shared with the bot by the user

      Returns EncryptedPassportElement

    Protected_update

    • _update(data: Record<string, any>): Base
      Protected

      Updates the current instance with new data and returns a clone of the updated instance

      Parameters

      • data: Record<string, any>

        The data to update the instance with

      Returns Base

      A clone of the updated instance

    • Flatten an object. Any properties that are collections will get converted to an array of keys.

      Parameters

      • OptionalpropsRecursive: boolean

        Optional. If true, calls toJSON method on nested objects.

      • ...props: Record<string, string | boolean>[]

        Optional. Specific properties to include/exclude, or rename.

      Returns Record<string, any>

      Flattened object.

    • Returns the id instance Chat, User, ChatMember and other

      Returns string | null

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods