new Observations(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) searchObservations(observationFilteropt, pageSizeopt) → {Promise.<Collection.<Observation>>}
List or search all observations available through this API.
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
observationFilter |
ObservationFilter
|
<optional>
|
new ObservationFilter()
|
default observation filter |
pageSize |
Number
|
<optional>
|
10
|
default page size |
- Source:
Returns:
- A Collection of Observation
-
Type
-
Promise.<Collection.<Observation>>