Interface QrCodeAuthParams

Hierarchy

UserPasswordAuthParams
- QrCodeAuthParams

Index

Methods

Methods

Optional password

password(hint?: string): Promise<string>

Inherited from UserPasswordAuthParams.password
- Defined in gramjs/client/auth.ts:36
optional string or callback that should return the 2FA password if present.
the password hint will be sent in the hint param

Parameters
- Optional hint: string
Returns Promise<string>

Optional qrCode

qrCode(qrCode: { token: Buffer; expires: number }): Promise<void>

- Defined in gramjs/client/auth.ts:45
a qrCode token for login through qrCode.
this would need a QR code that you should scan with another app to login with.

Parameters
- qrCode: { token: Buffer; expires: number }
  - token: Buffer
  - expires: number
Returns Promise<void>

onError

onError(err: Error): void | Promise<boolean>

Overrides UserPasswordAuthParams.onError
- Defined in gramjs/client/auth.ts:48
when an error happens during auth this function will be called with the error.
if this returns true the auth operation will stop.

Parameters
- err: Error
Returns void | Promise<boolean>

Generated using TypeDoc