Class RealtimeAsset

Represents an asset in sharedb

Hierarchy

Events
- RealtimeAsset

Index

Constructors

Accessors

data id loaded uniqueId

Methods

load submitOp unload whenNothingPending

Constructors

constructor

new RealtimeAsset(uniqueId, realtime, connection): RealtimeAsset
Constructor
Parameters
- uniqueId: number
  The unique asset id
- realtime: Realtime
  The realtime API
- connection: RealtimeConnection
  The realtime connection
Returns RealtimeAsset
Overrides Events.constructor
- Defined in editor-api/src/realtime/asset.js:20

Accessors

data

get data(): object
The asset data

Returns object
- Defined in editor-api/src/realtime/asset.js:140

id

get id(): number
The asset id - used in combination with branch id

Returns number
- Defined in editor-api/src/realtime/asset.js:149

loaded

get loaded(): boolean
Whether the asset is loaded

Returns boolean
- Defined in editor-api/src/realtime/asset.js:131

uniqueId

get uniqueId(): number
The asset's unique id

Returns number
- Defined in editor-api/src/realtime/asset.js:158

Methods

load

load(): void
Loads asset from sharedb and subscribes to changes.

Returns void
- Defined in editor-api/src/realtime/asset.js:34

submitOp

submitOp(op): void
Submits sharedb operation
Parameters
- op: object
  The operation
Returns void
- Defined in editor-api/src/realtime/asset.js:68

unload

unload(): void
Unloads asset from sharedb and unsubscribes from changes.

Returns void
- Defined in editor-api/src/realtime/asset.js:49

whenNothingPending

whenNothingPending(callback): void
Calls the callback when there are no changes pending to be sent to the server
Parameters
- callback: Function
  The callback
Returns void
- Defined in editor-api/src/realtime/asset.js:85