Class SceneCollectionsService

Hierarchy

SceneCollectionsService

Index

Accessors

Methods

Accessors

activeCollection

get activeCollection(): ISceneCollectionsManifestEntry

- Defined in scene-collections/scene-collections.ts:39
Returns ISceneCollectionsManifestEntry

collectionAdded

get collectionAdded(): Observable<ISceneCollectionsManifestEntry>

- Defined in scene-collections/scene-collections.ts:68
Returns Observable<ISceneCollectionsManifestEntry>

collectionRemoved

get collectionRemoved(): Observable<ISceneCollectionsManifestEntry>

- Defined in scene-collections/scene-collections.ts:72
Returns Observable<ISceneCollectionsManifestEntry>

collectionSwitched

get collectionSwitched(): Observable<ISceneCollectionsManifestEntry>

- Defined in scene-collections/scene-collections.ts:80
Returns Observable<ISceneCollectionsManifestEntry>

collectionUpdated

get collectionUpdated(): Observable<ISceneCollectionsManifestEntry>

- Defined in scene-collections/scene-collections.ts:84
Returns Observable<ISceneCollectionsManifestEntry>

collectionWillSwitch

get collectionWillSwitch(): Observable<void>

- Defined in scene-collections/scene-collections.ts:76
Returns Observable<void>

collections

get collections(): ISceneCollectionsManifestEntry[]

- Defined in scene-collections/scene-collections.ts:88
Returns ISceneCollectionsManifestEntry[]

Methods

create

create(options: ISceneCollectionCreateOptions): Promise<ISceneCollectionsManifestEntry>

- Defined in scene-collections/scene-collections.ts:47
Parameters
- options: ISceneCollectionCreateOptions
Returns Promise<ISceneCollectionsManifestEntry>

delete

delete(id?: string): Promise<void>

- Defined in scene-collections/scene-collections.ts:64
Deletes a scene collection. If no id is specified, it will delete the current collection.

Parameters
- Optional id: string
  
  the id of the collection to delete
Returns Promise<void>

fetchSceneCollectionsSchema

fetchSceneCollectionsSchema(): Promise<ISceneCollectionSchema[]>

- Defined in scene-collections/scene-collections.ts:43
Returns Promise<ISceneCollectionSchema[]>

load

load(id: string): Promise<void>

- Defined in scene-collections/scene-collections.ts:51
Parameters
- id: string
Returns Promise<void>

rename

rename(newName: string, id: string): Promise<void>

- Defined in scene-collections/scene-collections.ts:55
Parameters
- newName: string
- id: string
Returns Promise<void>