Class MeasurementService

This class allows for managing measurements.

Hierarchy (view full)

Service<IMeasurement>
- MeasurementService

Index

Constructors

Methods

create delete detail list listSeries

Constructors

constructor

new MeasurementService(client, realtime?): MeasurementService
Parameters
- client: IFetchClient
- Optionalrealtime: Realtime
Returns MeasurementService
Inherited from Service.constructor
- Defined in packages/client/src/core/Service.ts:18

Methods

create

create(entity): Promise<IResult<IMeasurement>>
Creates a new measurement.
Parameters
- entity: Partial<IMeasurementCreate>
  At least sourceId is mandantory.
Returns Promise<IResult<IMeasurement>>
Response wrapped in [[IResult]]

Example
```
 const mandantoryObject: Partial<IMeasurementCreate> = {
   sourceId: device.id,
   fragment: { series: { unit: '%', value: 51 } },
 };

 (async () => {
   const {data, res} = await measurementService.create(mandantoryObject);
 })();
```
Overrides Service.create
- Defined in packages/client/src/measurement/MeasurementService.ts:59

delete

delete(entityOrId): Promise<IResult<null>>
Removes a measurement with given id.
Parameters
- entityOrId: string | number | IIdentified
Returns Promise<IResult<null>>
Response wrapped in [[IResult]]
Deprecated
As of version 10.16.0.0 and the usage of the time series database, deleting a single measurement via id is not supported any more.

Example
```
  const id: number = 1;

   (async () => {
     const {data, res} = await measurementService.delete(id);
  })();
```
Overrides Service.delete
- Defined in packages/client/src/measurement/MeasurementService.ts:107

detail

detail(entityOrId): Promise<IResult<IMeasurement>>
Gets the details of selected measurement.
Parameters
- entityOrId: string | number | IIdentified
  Entity or Id of the entity.
Returns Promise<IResult<IMeasurement>>
Response wrapped in [[IResult]]
Deprecated
As of version 10.16.0.0 and the usage of the time series database, reading a single measurement via id is not supported any more.

Example
```
   const measurementId: number = 1;

   (async () => {
     const {data, res} = await measurementService.detail(measurementId);
  })();
```
Overrides Service.detail
- Defined in packages/client/src/measurement/MeasurementService.ts:35

list

list(filter?): Promise<IResultList<IMeasurement>>
Gets the list of measurements filtered by parameters.
Parameters
- filter: object = {}
  Object containing filters for querying measurements.
  
  Example
```
 const filter: object = {
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await measurementService.list(filter);
  })();
```
Returns Promise<IResultList<IMeasurement>>
Response wrapped in [[IResultList]]
Overrides Service.list
- Defined in packages/client/src/measurement/MeasurementService.ts:83

listSeries

listSeries(params): Promise<IResult<ISeries>>
Gets the list of series in a measurement filtered by parameters.
Parameters
- params: ISeriesFilter
Returns Promise<IResult<ISeries>>
Response wrapped in [[IResult]]
- Defined in packages/client/src/measurement/MeasurementService.ts:132