Class DehydrationManager

Hierarchy

DehydrationManager

Index

Constructors

Properties

crypto deviceDisplayName? inProgress key? keyInfo? timeoutId

Methods

dehydrateDevice getDehydrationKeyFromCache setKey setKeyAndQueueDehydration stop

Constructors

constructor

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

Properties

`Private` `Readonly` crypto

crypto: Crypto

`Private` `Optional` deviceDisplayName

deviceDisplayName?: string

`Private` inProgress

inProgress: boolean = false

`Private` `Optional` key

key?: Uint8Array

`Private` `Optional` keyInfo

keyInfo?: {
[props: string]: any;
}

Type declaration

[props: string]: any

`Private` timeoutId

timeoutId: any

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:130

getDehydrationKeyFromCache

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

setKey

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

setKeyAndQueueDehydration

setKeyAndQueueDehydration(key: Uint8Array, keyInfo?: {
[props: string]: any;
}, deviceDisplayName?: string): 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
- Optional deviceDisplayName: string
Returns Promise<void>
- Defined in src/crypto/dehydration.ts:79

stop

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

Generated using TypeDoc