Class QRCodeData

Hierarchy

QRCodeData

Index

Constructors

Properties

buffer mode myMasterKey otherDeviceKey otherUserMasterKey sharedSecret

Accessors

encodedSharedSecret

Methods

getBuffer create determineMode generateBuffer generateQrData generateSharedSecret getOtherDeviceKey

Constructors

constructor

new QRCodeData(mode: Mode, sharedSecret: string, otherUserMasterKey: null | string, otherDeviceKey: null | string, myMasterKey: null | string, buffer: Buffer): QRCodeData
Parameters
- mode: Mode
- sharedSecret: string
- otherUserMasterKey: null | string
- otherDeviceKey: null | string
- myMasterKey: null | string
- buffer: Buffer
Returns QRCodeData
- Defined in src/crypto/verification/QRCode.ts:151

Properties

`Private` `Readonly` buffer

buffer: Buffer

`Readonly` mode

mode: Mode

`Readonly` myMasterKey

myMasterKey: null | string

`Readonly` otherDeviceKey

otherDeviceKey: null | string

`Readonly` otherUserMasterKey

otherUserMasterKey: null | string

`Private` `Readonly` sharedSecret

sharedSecret: string

Accessors

encodedSharedSecret

get encodedSharedSecret(): string
The unpadded base64 encoded shared secret.

Returns string
- Defined in src/crypto/verification/QRCode.ts:195

Methods

getBuffer

getBuffer(): Buffer
Returns Buffer
- Defined in src/crypto/verification/QRCode.ts:199

`Static` create

create(request: VerificationRequest<IVerificationChannel>, client: MatrixClient): Promise<QRCodeData>
Parameters
- request: VerificationRequest<IVerificationChannel>
- client: MatrixClient
Returns Promise<QRCodeData>
- Defined in src/crypto/verification/QRCode.ts:163

`Static` `Private` determineMode

determineMode(request: VerificationRequest<IVerificationChannel>, client: MatrixClient): Mode
Parameters
- request: VerificationRequest<IVerificationChannel>
- client: MatrixClient
Returns Mode
- Defined in src/crypto/verification/QRCode.ts:219

`Static` `Private` generateBuffer

generateBuffer(qrData: IQrData): Buffer
Parameters
- qrData: IQrData
Returns Buffer
- Defined in src/crypto/verification/QRCode.ts:277

`Static` `Private` generateQrData

generateQrData(request: VerificationRequest<IVerificationChannel>, client: MatrixClient, mode: Mode, encodedSharedSecret: string, otherUserMasterKey?: string, otherDeviceKey?: string, myMasterKey?: string): IQrData
Parameters
- request: VerificationRequest<IVerificationChannel>
- client: MatrixClient
- mode: Mode
- encodedSharedSecret: string
- Optional otherUserMasterKey: string
- Optional otherDeviceKey: string
- Optional myMasterKey: string
Returns IQrData
- Defined in src/crypto/verification/QRCode.ts:236

`Static` `Private` generateSharedSecret

generateSharedSecret(): string
Returns string
- Defined in src/crypto/verification/QRCode.ts:203

`Static` `Private` getOtherDeviceKey

getOtherDeviceKey(request: VerificationRequest<IVerificationChannel>, client: MatrixClient): Promise<string>
Parameters
- request: VerificationRequest<IVerificationChannel>
- client: MatrixClient
Returns Promise<string>
- Defined in src/crypto/verification/QRCode.ts:209

Generated using TypeDoc