Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IoStateEventData

Defines event data format for association/disassociation related to a specific IO source/actor.

This data is emitted by the observable returned by CommunicationManager.observeIoState.

Hierarchy

  • CommunicationEventData
    • IoStateEventData

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new IoStateEventData(hasAssociations: boolean, updateRate?: number): IoStateEventData

  • Create a new IoStateEventData instance.

    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 IoStateEventData

Accessors

hasAssociations

  • get hasAssociations(): boolean

  • Determines whether the related IO source/actor has associations.

    Returns boolean

updateRate

  • get updateRate(): number

  • The recommended update rate (in millis) for publishing IO source values (optional).

    The value is only specified for association events that are observed by an IO source; otherwise undefined.

    Returns number

Methods

toJsonObject

  • toJsonObject(): { hasAssociations: boolean; updateRate: number }

  • Returns { hasAssociations: boolean; updateRate: number }

    • hasAssociations: boolean
    • updateRate: number

Generated using TypeDoc