Interface IScene

Hierarchy

EventEmitter
- IScene

Implemented by

Scene

Properties

controls

controls: Map<string, IControl>

etag

etag: string

deprecated: etags are no longer used, you can always omit/ignore this

groups

groups: any

meta

meta: IMeta

sceneID

sceneID: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:717
Parameters
- event: string | symbol
- listener: Function
Returns this

createControl

createControl(controlData: IControlData): Promise<IControl>

- Defined in state/interfaces/IScene.ts:75
Parameters
- controlData: IControlData
Returns Promise<IControl>

createControls

createControls(controls: IControlData[]): Promise<IControl[]>

- Defined in state/interfaces/IScene.ts:76
Parameters
- controls: IControlData[]
Returns Promise<IControl[]>

deleteAllControls

deleteAllControls(): Promise<void>

- Defined in state/interfaces/IScene.ts:80
Returns Promise<void>

deleteControl

deleteControl(controlIDs: string): Promise<void>

- Defined in state/interfaces/IScene.ts:79
Parameters
- controlIDs: string
Returns Promise<void>

deleteControls

deleteControls(controlIDs: string[]): Promise<void>

- Defined in state/interfaces/IScene.ts:78
Parameters
- controlIDs: string[]
Returns Promise<void>

destroy

destroy(): void

- Defined in state/interfaces/IScene.ts:88
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:727
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:728
Returns (string | symbol)[]

getControl

getControl(id: string): IControl

- Defined in state/interfaces/IScene.ts:72
Parameters
- id: string
Returns IControl

getControls

getControls(): IControl[]

- Defined in state/interfaces/IScene.ts:73
Returns IControl[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:725
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:729
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:726
Parameters
- event: string | symbol
Returns Function[]

on

on(event: "controlAdded", listener: function): this
on(event: "controlDeleted", listener: function): this
on(event: "update", listener: function): this
on(event: string, listener: Function): this

Overrides EventEmitter.on
- Defined in state/interfaces/IScene.ts:93
Fired when a control is added to the scene.

Parameters
- event: "controlAdded"
- listener: function
  - - (control: IControl): void
    - Parameters
      - control: IControl
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/interfaces/IScene.ts:97
Fired when a control is removed from the scene.

Parameters
- event: "controlDeleted"
- listener: function
  - - (controlId: string): void
    - Parameters
      - controlId: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/interfaces/IScene.ts:101
Fired when the scene is updated with new data from the server.

Parameters
- event: "update"
- listener: function
  - - (controlId: this): void
    - Parameters
      - controlId: this
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/interfaces/IScene.ts:102
Parameters
- event: string
- listener: Function
Returns this

onControlsCreated

onControlsCreated(controls: IControlData[]): IControl[]

- Defined in state/interfaces/IScene.ts:82
Parameters
- controls: IControlData[]
Returns IControl[]

onControlsDeleted

onControlsDeleted(controls: IControlData[]): void

- Defined in state/interfaces/IScene.ts:84
Parameters
- controls: IControlData[]
Returns void

onControlsUpdated

onControlsUpdated(controls: IControlData[]): void

- Defined in state/interfaces/IScene.ts:83
Parameters
- controls: IControlData[]
Returns void

once

once(event: string | symbol, listener: Function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:719
Parameters
- event: string | symbol
- listener: Function
Returns this

prependListener

prependListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:720
Parameters
- event: string | symbol
- listener: Function
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:721
Parameters
- event: string | symbol
- listener: Function
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:723
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:722
Parameters
- event: string | symbol
- listener: Function
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:724
Parameters
- n: number
Returns this

update

update(scene: ISceneData): void

- Defined in state/interfaces/IScene.ts:86
Parameters
- scene: ISceneData
Returns void

updateControls

updateControls(controls: IControlData[]): Promise<void>

- Defined in state/interfaces/IScene.ts:77
Parameters
- controls: IControlData[]
Returns Promise<void>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:714
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc