Class ESPCDFScene

Implements

ESPCDFSceneInterface

Index

Constructors

Properties

_raw actions adaptorIdentifier? devicesCount events id info? name nodes operations

Methods

activate add dispose edit remove subscribe

Constructors

constructor

new ESPCDFScene(sceneData: ESPCDFSceneInterface): ESPCDFScene
Parameters
- sceneData: ESPCDFSceneInterface
Returns ESPCDFScene
- Defined in src/entities/ESPCDFScene.ts:38

Properties

_raw

_raw: any

actions

actions: { [key: string]: { [key: string]: any } }

`Optional`adaptorIdentifier

adaptorIdentifier?: string

devicesCount

devicesCount: number

`Readonly`events

events: ESPCDFOperationEventEmitter<ESPCDFScene, ESPCDFSceneOperationType>

id

id: string

`Optional`info

info?: string

name

name: string

nodes

nodes: string[]

operations

operations: ESPCDFSceneOperation

Methods

activate

activate(): Promise<ESPCDFAPIResponse<any>>
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFScene.ts:130

add

add(): Promise<ESPCDFAPIResponse<any>>
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFScene.ts:118

dispose

dispose(): void
Remove all listeners and clean up

Returns void
- Defined in src/entities/ESPCDFScene.ts:73

edit

edit(data: ESPCDFSceneEditInput): Promise<ESPCDFAPIResponse<any>>
Parameters
- data: ESPCDFSceneEditInput
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFScene.ts:122

remove

remove(): Promise<ESPCDFAPIResponse<any>>
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFScene.ts:126

subscribe(
listener: ESPCDFOperationListener<ESPCDFScene, ESPCDFSceneOperationType>,
): () => void
Subscribe to all operation events
Parameters
- listener: ESPCDFOperationListener<ESPCDFScene, ESPCDFSceneOperationType>
  The callback function to register
Returns () => void
Unsubscribe function
- Defined in src/entities/ESPCDFScene.ts:64