LiveObject

LiveObject

The LiveObject API allows easily retrieve the queried data asynchronously, as well as subscribe to any new changes to the data.
Note: you will never need to create a LiveObject instances directly. They are returned by SDK's repositories APIs

LiveObject instance fires:
- dataStatusChanged
- loadingStatusChanged
- dataUpdated
- dataError

Extends

  • EventEmitter

Members

(readonly) dataStatus :EkoDataStatus

The LiveObject data status.
Type:

(readonly) loadingStatus :EkoLoadingStatus

The LiveObject loading status.
Type:

(readonly) model :Object|undefined

Get a plain object of the LiveObject instance data.
Type:
  • Object | undefined

Methods

dispose()

Disposes the LiveObject instance. Stops all observers, removes all listeners and cleans internal data.

Events

dataStatusChanged

Properties:
Name Type Attributes Description
oldValue EkoDataStatus <optional>
The old data status.
newValue EkoDataStatus The new data status.
Fires every time when dataStatus changes.
Type:
  • Object

loadingStatusChanged

Properties:
Name Type Attributes Description
oldValue EkoLoadingStatus <optional>
The old loading status.
newValue EkoLoadingStatus The new loading status.
Fires every time when loadingStatus changes.
Type:
  • Object

dataUpdated

Fires every time when data model updated.
Type:
  • Object

dataError

Fires every time when asynchronous error occurs.
Type:
  • EkoSDKError