Class DehydrationManager

Index

Constructors

Methods

dehydrateDevice getDehydrationKeyFromCache setKey setKeyAndQueueDehydration stop

Constructors

constructor

new DehydrationManager(crypto): DehydrationManager
Parameters
- crypto: Crypto
Returns DehydrationManager
- Defined in src/crypto/dehydration.ts:53

Methods

dehydrateDevice

dehydrateDevice(): Promise<undefined | string>
returns the device id of the newly created dehydrated device

Returns Promise<undefined | string>
- Defined in src/crypto/dehydration.ts:131

getDehydrationKeyFromCache

getDehydrationKeyFromCache(): Promise<void>
Returns Promise<void>
- Defined in src/crypto/dehydration.ts:57

setKey

setKey(key, keyInfo?, deviceDisplayName?): Promise<undefined | boolean>
Parameters
- key: Uint8Array
- keyInfo: {
  [props: string]: any;
  } = {}
  - [props: string]: any
- OptionaldeviceDisplayName: string
Returns Promise<undefined | boolean>
- Defined in src/crypto/dehydration.ts:92

setKeyAndQueueDehydration

setKeyAndQueueDehydration(key, keyInfo?, deviceDisplayName?): Promise<void>
set the key, and queue periodic dehydration to the server in the background
Parameters
- key: Uint8Array
- keyInfo: {
  [props: string]: any;
  } = {}
  - [props: string]: any
- OptionaldeviceDisplayName: string
Returns Promise<void>
- Defined in src/crypto/dehydration.ts:80

stop

stop(): void
Returns void
- Defined in src/crypto/dehydration.ts:266