Interface ShowSasCallbacks

Callbacks for user actions while a SAS is displayed.

This is exposed as the payload of a VerifierEvent.ShowSas event, or directly from the verifier as sasEvent.

interface ShowSasCallbacks {
    sas: GeneratedSas;
    cancel(): void;
    confirm(): Promise<void>;
    mismatch(): void;
}

Index

Properties

Methods

cancel confirm mismatch

Properties

sas

sas: GeneratedSas

The generated SAS to be shown to the user

Methods

cancel

cancel(): void
Cancel the verification flow

Returns void
- Defined in src/crypto-api/verification.ts:348

confirm

confirm(): Promise<void>
Function to call if the user confirms that the SAS matches.

Returns Promise<void>
A Promise that completes once the m.key.verification.mac is queued.
- Defined in src/crypto-api/verification.ts:338

mismatch

mismatch(): void
Function to call if the user finds the SAS does not match.

Sends an m.key.verification.cancel event with a m.mismatched_sas error code.

Returns void
- Defined in src/crypto-api/verification.ts:345