- Preparing search index...
- The search index is not available
matrix-js-sdk
Type alias CryptoEventHandlerMap
Crypto
EventHandlerMap: {
crossSigning.keysChanged: ((data: {}) => void);
crypto.devicesUpdated: ((users: string[], initialFetch: boolean) => void);
crypto.keyBackupFailed: ((errcode: string) => void);
crypto.keyBackupSessionsRemaining: ((remaining: number) => void);
crypto.keyBackupStatus: ((enabled: boolean) => void);
crypto.keySignatureUploadFailure: ((failures: IUploadKeySignaturesResponse["failures"], source: "checkOwnCrossSigningTrust" | "afterCrossSigningLocalKeyChange" | "setDeviceVerification", upload: ((opts: {
shouldEmit: boolean;
}) => Promise<void>)) => void);
crypto.roomKeyRequest: ((request: IncomingRoomKeyRequest) => void);
crypto.roomKeyRequestCancellation: ((request: IncomingRoomKeyRequestCancellation) => void);
crypto.verification.request: ((request: VerificationRequest<any>) => void);
crypto.warning: ((type: string) => void);
crypto.willUpdateDevices: ((users: string[], initialFetch: boolean) => void);
deviceVerificationChanged: ((userId: string, deviceId: string, device: DeviceInfo) => void);
userCrossSigningUpdated: ((userId: string) => void);
userTrustStatusChanged: ((userId: string, trustLevel: UserTrustLevel) => void);
}
Type declaration
-
crossSigning.keysChanged: ((data: {}) => void)
-
- (data: {}): void
Experimental
Returns void
-
crypto.devicesUpdated: ((users: string[], initialFetch: boolean) => void)
-
- (users: string[], initialFetch: boolean): void
-
Parameters
-
users: string[]
-
initialFetch: boolean
Returns void
-
crypto.keyBackupFailed: ((errcode: string) => void)
-
- (errcode: string): void
-
Returns void
-
crypto.keyBackupSessionsRemaining: ((remaining: number) => void)
-
- (remaining: number): void
-
Returns void
-
crypto.keyBackupStatus: ((enabled: boolean) => void)
-
- (enabled: boolean): void
-
Returns void
-
crypto.keySignatureUploadFailure: ((failures: IUploadKeySignaturesResponse["failures"], source: "checkOwnCrossSigningTrust" | "afterCrossSigningLocalKeyChange" | "setDeviceVerification", upload: ((opts: {
shouldEmit: boolean;
}) => Promise<void>)) => void)
-
- (failures: IUploadKeySignaturesResponse["failures"], source: "checkOwnCrossSigningTrust" | "afterCrossSigningLocalKeyChange" | "setDeviceVerification", upload: ((opts: {
shouldEmit: boolean;
}) => Promise<void>)): void
-
Parameters
-
-
source: "checkOwnCrossSigningTrust" | "afterCrossSigningLocalKeyChange" | "setDeviceVerification"
-
upload: ((opts: {
shouldEmit: boolean;
}) => Promise<void>)
-
- (opts: {
shouldEmit: boolean;
}): Promise<void>
-
Parameters
-
opts: {
shouldEmit: boolean;
}
Returns Promise<void>
Returns void
-
-
-
crypto.verification.request: ((request: VerificationRequest<any>) => void)
-
crypto.warning: ((type: string) => void)
-
- (type: string): void
-
Returns void
-
crypto.willUpdateDevices: ((users: string[], initialFetch: boolean) => void)
-
- (users: string[], initialFetch: boolean): void
-
Parameters
-
users: string[]
-
initialFetch: boolean
Returns void
-
deviceVerificationChanged: ((userId: string, deviceId: string, device: DeviceInfo) => void)
-
- (userId: string, deviceId: string, device: DeviceInfo): void
-
Parameters
-
userId: string
-
deviceId: string
-
Returns void
-
userCrossSigningUpdated: ((userId: string) => void)
-
- (userId: string): void
-
Returns void
-
userTrustStatusChanged: ((userId: string, trustLevel: UserTrustLevel) => void)
-
- (userId: string, trustLevel: UserTrustLevel): void
Experimental
Returns void
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.