Class AnnotationMeasurementService

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

Implements

AnnotationMeasurementServiceInterface

Index

Constructors

Methods

createAnnotationMeasurement deleteAnnotationMeasurement 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:33

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:44

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:172

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:114