SessionStore

class

Back to Helios Web API

Kind

class

Source

src/storage/HeliosStorageManager.js:530

Description

Low-level session record store used by Helios storage managers.

Signature

export class SessionStore {

Configuration

General configuration setters and compatibility helpers.

get(id, options = {})

Source: src/storage/HeliosStorageManager.js:677

Returns the current get value or state.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to get.
options	Object	optional	{}	Options object for this operation.

getAll()

Source: src/storage/HeliosStorageManager.js:722

Returns the current all value or state.

Example

const value = helios.getAll();

getUnfinishedSessionId(workspaceId = null)

Source: src/storage/HeliosStorageManager.js:757

Returns the current unfinished session id value or state.

Parameters

Name	Type	Attributes	Default	Description
workspaceId		optional	null	Value passed to getUnfinishedSessionId.

setUnfinishedSessionId(id, workspaceId = null) → {this}

Source: src/storage/HeliosStorageManager.js:763

Set the unfinished session id setting.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to setUnfinishedSessionId.
workspaceId		optional	null	Value passed to setUnfinishedSessionId.

Returns

This instance.

Type this

Utilities

Additional public helpers that do not belong to a narrower API area.

key(id)

Source: src/storage/HeliosStorageManager.js:539

Configures or reads key.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to key.

networkDataRecordId(id)

Source: src/storage/HeliosStorageManager.js:543

Configures or reads network data record id.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to networkDataRecordId.

positionDataRecordId(id)

Source: src/storage/HeliosStorageManager.js:547

Configures or reads position data record id.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to positionDataRecordId.

unfinishedSessionKeyFor(workspaceId = null)

Source: src/storage/HeliosStorageManager.js:551

Configures or reads unfinished session key for.

Parameters

Name	Type	Attributes	Default	Description
workspaceId		optional	null	Value passed to unfinishedSessionKeyFor.

put(record)

Source: src/storage/HeliosStorageManager.js:660

Configures or reads put.

Parameters

Name	Type	Attributes	Default	Description
record				Value passed to put.

delete(id)

Source: src/storage/HeliosStorageManager.js:744

Configures or reads delete.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to delete.