Enumeration CryptoEvent

Events emitted by the CryptoApi

Enumeration Members

DevicesUpdated

Fires whenever the stored devices for a user have been updated The payload is a pair (userIds, initialFetch).

KeyBackupDecryptionKeyCached

Fires when a new valid backup decryption key is in cache. This will happen when a secret is received from another session, from secret storage, or when a new backup is created from this session.

The payload is the version of the backup for which we have the key for.

This event is only fired by the rust crypto backend.

KeyBackupFailed

Fires when we failed to back up the keys The payload is the error code of the error that occurred.

KeyBackupSessionsRemaining

Fires when the number of sessions that can be backed up changes. The payload is the remaining number of sessions that can be backed up.

KeyBackupStatus

Fires when the key backup status changes. The payload is a boolean indicating whether the key backup is enabled.

KeysChanged

Fires when the user's cross-signing keys have changed or cross-signing has been enabled/disabled. The client can use getStoredCrossSigningForUser with the user ID of the logged in user to check if cross-signing is enabled on the account. If enabled, it can test whether the current key is trusted using with checkUserTrust with the user ID of the logged in user. The checkOwnCrossSigningTrust function may be used to reconcile the trust in the account key.

The cross-signing API is currently UNSTABLE and may change without notice.

LegacyCryptoStoreMigrationProgress

Fires when data is being migrated from legacy crypto to rust crypto.

The payload is a pair (progress, total), where progress is the number of steps completed so far, and total is the total number of steps. When migration is complete, a final instance of the event is emitted, with progress === total === -1.

UserTrustStatusChanged

Fires when the trust status of a user changes. The payload is a pair (userId, userTrustLevel). The trust level is one of the values from UserVerificationStatus.

VerificationRequestReceived

Fires when a key verification request is received. The payload is a VerificationRequest object representing the request.

WillUpdateDevices

Use DevicesUpdated instead when using rust crypto