srvEntitiesWatcher defines the API for methods on a state.StringsWatcher. Each client has its own current set of watchers, stored in resources. srvEntitiesWatcher notifies about changes for all entities of a given kind, sending the changes as a list of strings, which could be transformed from state entity ids to their corresponding entity tags.

Hierarchy

  • default

Implements

Constructors

Properties

Methods

Constructors

Properties

NAME: string = "EntityWatcher"
VERSION: number = 2
_transport: Transport
NAME: string = "EntityWatcher"
VERSION: number = 2

Methods

  • Next returns when a change has occurred to an entity of the collection being watched since the most recent call to Next or the Watch call that created the srvEntitiesWatcher.

    Parameters

    • params: any

    Returns Promise<EntitiesWatchResult>

  • Stop stops the watcher.

    Parameters

    • params: any

    Returns Promise<any>

Generated using TypeDoc