Class IoStateEvent

IoState event.

This event is internally emitted by the observable returned by CommunicationManager.observeIoState.

Hierarchy

IoStateEvent

Index

Constructors

constructor

Accessors

data

Methods

with

Constructors

constructor

new IoStateEvent(eventData: IoStateEventData): IoStateEvent

- Defined in src/com/io-state.ts:23
internal
For internal use in framework only.

Parameters
- eventData: IoStateEventData
Returns IoStateEvent

Accessors

data

get data(): IoStateEventData

- Defined in src/com/io-state.ts:16
Gets the data of this event.

Returns IoStateEventData

Methods

Static with

with(hasAssociations: boolean, updateRate?: number): IoStateEvent

- Defined in src/com/io-state.ts:37
Create an IoStateEvent instance for describing an IO state.

internal
For internal use in framework only.

Parameters
- hasAssociations: boolean
  
  determines whether the related IO source/actor has associations
- Optional updateRate: number
  
  the recommended update rate (in millis) for publishing IO source values (optional)
Returns IoStateEvent

Generated using TypeDoc