Interface IdentityContextStorage

interface IdentityContextStorage {
    open(identityId: string): Promise<void>;
    save(data: IdentityContextData): Promise<void>;
    load(): Promise<null | IdentityContextData>;
    clear(): Promise<void>;
    close(): Promise<void>;
    openAndLoad(identityId: string): Promise<null | IdentityContextData>;
    setCacheKey(key: CryptoKey): void;
    getCacheKey(): null | CryptoKey;
    persistCacheKey(): Promise<void>;
    loadPersistedKey(): Promise<null | CryptoKey>;
}

Implemented by

IdentityContextIDBStorage

Index

Methods

open save load clear close openAndLoad setCacheKey getCacheKey persistCacheKey loadPersistedKey

Methods

open

open(identityId): Promise<void>
Parameters
- identityId: string
Returns Promise<void>
- Defined in headless/identity-context-types.ts:15

save

save(data): Promise<void>
Parameters
- data: IdentityContextData
Returns Promise<void>
- Defined in headless/identity-context-types.ts:16

load

load(): Promise<null | IdentityContextData>
Returns Promise<null | IdentityContextData>
- Defined in headless/identity-context-types.ts:17

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in headless/identity-context-types.ts:18

close

close(): Promise<void>
Returns Promise<void>
- Defined in headless/identity-context-types.ts:19

openAndLoad

openAndLoad(identityId): Promise<null | IdentityContextData>
Open storage for identity and atomically load cached context.
Parameters
- identityId: string
Returns Promise<null | IdentityContextData>
- Defined in headless/identity-context-types.ts:21

setCacheKey

setCacheKey(key): void
Set the persisted cache key (called at login).
Parameters
- key: CryptoKey
Returns void
- Defined in headless/identity-context-types.ts:23

getCacheKey

getCacheKey(): null | CryptoKey
Get the currently set cache key, or null.

Returns null | CryptoKey
- Defined in headless/identity-context-types.ts:25

persistCacheKey

persistCacheKey(): Promise<void>
Persist the CryptoKey to IndexedDB for warm return after browser restart.

Returns Promise<void>
- Defined in headless/identity-context-types.ts:27

loadPersistedKey

loadPersistedKey(): Promise<null | CryptoKey>
Load a previously persisted CryptoKey from IndexedDB.

Returns Promise<null | CryptoKey>
- Defined in headless/identity-context-types.ts:29