Class: ControlStreams

ControlStreams(networkPropertiesopt)

new ControlStreams(networkPropertiesopt)

Parameters:
Name Type Attributes Default Description
networkProperties Object <optional>
 {}
Properties
Name Type Attributes Default Description
endpointUrl String defines the Http(s) endpoint URL
tls Boolean defines is use Http or Https secure protocol for fetching data
streamProtocol String <optional>
 'ws' the Stream protocol to use: 'ws' pr 'mqtt'
mqttOpts Object <optional>
 {} the Mqtt options if stream protocol is 'mqtt'
Properties
Name Type Description
prefix String the Mqtt prefix value
endpointUrl String the Mqtt specific endpointUrl
Source:

Methods

(async) getControlStreamById(controlstreamId, controlStreamFilteropt) → {Promise.<ControlStream>}

Get a specific controlstream resource by ID
Parameters:
Name Type Attributes Default Description
controlstreamId string ID of requested controlstream
controlStreamFilter ControlStreamFilter <optional>
 new ControlStreamFilter() default controlstream filter
Source:
Returns:
- The corresponding ControlStream
Type
Promise.<ControlStream>

(async) searchControlStreams(controlStreamFilteropt, pageSizeopt) → {Promise.<Collection.<ControlStream>>}

List or search all controlstreams available through this API.
Parameters:
Name Type Attributes Default Description
controlStreamFilter ControlStreamFilter <optional>
 new ControlStreamFilter() default ControlStream filter
pageSize Number <optional>
 10 default page size
Source:
Returns:
- A Collection of ControlStream
Type
Promise.<Collection.<ControlStream>>