Class RealtimeAssets

Provides methods to load assets from sharedb

Hierarchy

Events
- RealtimeAssets

Index

Constructors

Methods

get load unload

Constructors

constructor

new RealtimeAssets(
realtime: Realtime,
connection: RealtimeConnection,
): RealtimeAssets
Constructor
Parameters
- realtime: Realtime
  The realtime API
- connection: RealtimeConnection
  The realtime connection
Returns RealtimeAssets
Overrides Events.constructor
- Defined in submodules/editor-api/src/realtime/assets.js:19

Methods

get

get(id: number): RealtimeAsset
Gets an already loaded asset
Parameters
- id: number
  The asset's unique id
Returns RealtimeAsset
The asset
- Defined in submodules/editor-api/src/realtime/assets.js:52

load

load(id: number): RealtimeAsset
Loads an asset
Parameters
- id: number
  The asset's unique id
Returns RealtimeAsset
The asset
- Defined in submodules/editor-api/src/realtime/assets.js:32

unload

unload(id: number): void
Unloads an asset
Parameters
- id: number
  The asset's unique id
Returns void
- Defined in submodules/editor-api/src/realtime/assets.js:61