Class PassportData

Hierarchy (view full)

Base
- PassportData

Index

Constructors

Properties

credentials data

Accessors

Methods

_clone _patch _update setDataErrors toJSON valueOf

Constructors

constructor

new PassportData(client, data): PassportData
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: PassportData
  Data about the describes the user's Telegram Passport data shared with the bot
Returns PassportData
Overrides Base.constructor

Properties

credentials

credentials: {
    data: string;
    hash: string;
    secret: string;
}

Encrypted credentials required to decrypt the data.

data

data: EncryptedPassportElement[]

Array containing information about documents and other Telegram Passport elements shared with the bot.

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from Base._clone

`Protected`_patch

_patch(data): Record<string, any>
Protected
Patches the current instance with new data
Parameters
- data: Record<string, any>
  The data to patch the instance with
Returns Record<string, any>
The patched data

Inherited from Base._patch

`Protected`_update

_update(data): 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

Inherited from Base._update

setDataErrors

setDataErrors(userId, errors): Promise<true>
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change).
Parameters
- userId: string | number
  User identifier
- errors: readonly PassportElementError[]
  An array describing the errors
Returns Promise<true>
Returns True on success.

toJSON

toJSON(propsRecursive?, ...props): Record<string, any>
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.
- Rest...props: Record<string, string | boolean>[]
  Optional. Specific properties to include/exclude, or rename.
Returns Record<string, any>
Flattened object.

Inherited from Base.toJSON

valueOf

valueOf(): null | string
Returns the id instance Chat, User, ChatMember and other

Returns null | string
Inherited from Base.valueOf