Class AnnotationMeasurementService

Service for annotation measurement operations. Create, Update, and Delete measurement annotations.

Implements

AnnotationMeasurementServiceInterface

Index

Constructors

constructor

Methods

createAnnotationMeasurement deleteAnnotationMeasurement observeAnnotationMeasurements updateAnnotationMeasurement

Constructors

constructor

new AnnotationMeasurementService(
    connectClient: ConnectClientInterface,
    annotationMeasurementMapper: AnnotationMeasurementMapper,
    annotationCoreService: AnnotationCoreServiceInterface,
): AnnotationMeasurementService
Constructor for AnnotationMeasurementService.
Parameters
- connectClient: ConnectClientInterface
  Connect client to make API calls from the Connect SDK.
- annotationMeasurementMapper: AnnotationMeasurementMapper
  Mapper to map annotation measurement API response to annotation measurement object.
- annotationCoreService: AnnotationCoreServiceInterface
  Core annotation service to handle core annotation operations.
Returns AnnotationMeasurementService
Remarks
It is easier to use the AnnotationMeasurementServiceFactory to create an instance of this class as it will inject the required dependencies.
- Defined in packages/sdk/annotation/measurement/src/lib/service/annotationMeasurementService.ts:35

Methods

createAnnotationMeasurement

createAnnotationMeasurement(
options: CreateAnnotationMeasurementOptions,
): Promise<CreateAnnotationMeasurementResult>
Create a new measurement annotation.
Parameters
- options: CreateAnnotationMeasurementOptions
Returns Promise<CreateAnnotationMeasurementResult>
Implementation of AnnotationMeasurementServiceInterface.createAnnotationMeasurement
- Defined in packages/sdk/annotation/measurement/src/lib/service/annotationMeasurementService.ts:82

deleteAnnotationMeasurement

deleteAnnotationMeasurement(
id: AnnotationMeasurement.AnnotationMeasurementId,
): Promise<DeleteAnnotationResult>
Delete a measurement annotation by its id.
Parameters
- id: AnnotationMeasurement.AnnotationMeasurementId
Returns Promise<DeleteAnnotationResult>
Implementation of AnnotationMeasurementServiceInterface.deleteAnnotationMeasurement
- Defined in packages/sdk/annotation/measurement/src/lib/service/annotationMeasurementService.ts:209

observeAnnotationMeasurements

observeAnnotationMeasurements(
options: ObserveAnnotationMeasurementsOptions,
): (
callback: (measurements: ObserveAnnotationMeasurementResult) => void,
) => ObservedQueryHandle
Observe measurement annotations for a given asset instance.
Parameters
- options: ObserveAnnotationMeasurementsOptions
Returns (
callback: (measurements: ObserveAnnotationMeasurementResult) => void,
) => ObservedQueryHandle
Implementation of AnnotationMeasurementServiceInterface.observeAnnotationMeasurements
- Defined in packages/sdk/annotation/measurement/src/lib/service/annotationMeasurementService.ts:46

updateAnnotationMeasurement

updateAnnotationMeasurement(
options: UpdateAnnotationMeasurementOptions,
): Promise<UpdateAnnotationMeasurementResult>
Update an existing measurement annotation.
Parameters
- options: UpdateAnnotationMeasurementOptions
Returns Promise<UpdateAnnotationMeasurementResult>
Implementation of AnnotationMeasurementServiceInterface.updateAnnotationMeasurement
- Defined in packages/sdk/annotation/measurement/src/lib/service/annotationMeasurementService.ts:151

Class AnnotationMeasurementService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AnnotationMeasurementService

Remarks

Methods

createAnnotationMeasurement

Parameters

Returns Promise<CreateAnnotationMeasurementResult>

deleteAnnotationMeasurement

Parameters

Returns Promise<DeleteAnnotationResult>

observeAnnotationMeasurements

Parameters

Returns (
callback: (measurements: ObserveAnnotationMeasurementResult) => void,
) => ObservedQueryHandle

updateAnnotationMeasurement

Parameters

Returns Promise<UpdateAnnotationMeasurementResult>

Settings

On This Page

Class AnnotationMeasurementService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AnnotationMeasurementService

Remarks

Methods

createAnnotationMeasurement

Parameters

Returns Promise<CreateAnnotationMeasurementResult>

deleteAnnotationMeasurement

Parameters

Returns Promise<DeleteAnnotationResult>

observeAnnotationMeasurements

Parameters

Returns ( callback: (measurements: ObserveAnnotationMeasurementResult) => void,) => ObservedQueryHandle

updateAnnotationMeasurement

Parameters

Returns Promise<UpdateAnnotationMeasurementResult>

Settings

On This Page

Returns (
callback: (measurements: ObserveAnnotationMeasurementResult) => void,
) => ObservedQueryHandle