Class DehydratedDevices

Struct collecting methods to create and rehydrate dehydrated devices.

Index

Methods

create deleteDehydratedDeviceKey free getDehydratedDeviceKey rehydrate saveDehydratedDeviceKey

Methods

create

create(): Promise<DehydratedDevice>
Create a new DehydratedDevice which can be uploaded to the server.

Returns Promise<DehydratedDevice>
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:988

deleteDehydratedDeviceKey

deleteDehydratedDeviceKey(): Promise<void>
Clear the dehydrated device key saved in the crypto store.

Returns Promise<void>
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:1007

free

free(): void
Returns void
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:983

getDehydratedDeviceKey

getDehydratedDeviceKey(): Promise<undefined | DehydratedDeviceKey>
Get the cached dehydrated device key if any.

None if the key was not previously cached (via DehydratedDevices.saveDehydratedDeviceKey).

Returns Promise<undefined | DehydratedDeviceKey>
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:999

rehydrate

rehydrate(
    dehydrated_device_key: DehydratedDeviceKey,
    device_id: DeviceId,
    device_data: string,
): Promise<RehydratedDevice>
Rehydrate a dehydrated device.
Parameters
- dehydrated_device_key: DehydratedDeviceKey
- device_id: DeviceId
- device_data: string
Returns Promise<RehydratedDevice>
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:992

saveDehydratedDeviceKey

saveDehydratedDeviceKey(
dehydrated_device_key: DehydratedDeviceKey,
): Promise<void>
Store the dehydrated device key in the crypto store.
Parameters
- dehydrated_device_key: DehydratedDeviceKey
Returns Promise<void>
- Defined in pkg/matrix_sdk_crypto_wasm.d.ts:1003