Interface AnnotationMeasurementServiceInterface

Interface for annotation measurement service operations.

interface AnnotationMeasurementServiceInterface {
    createAnnotationMeasurement(
        options: CreateAnnotationMeasurementOptions,
    ): Promise<CreateAnnotationMeasurementResult>;
    deleteAnnotationMeasurement(
        id: AnnotationMeasurement.AnnotationMeasurementId,
    ): Promise<DeleteAnnotationResult>;
    updateAnnotationMeasurement(
        options: UpdateAnnotationMeasurementOptions,
    ): Promise<UpdateAnnotationMeasurementResult>;
}

Implemented by

AnnotationMeasurementService

Index

Methods

createAnnotationMeasurement deleteAnnotationMeasurement updateAnnotationMeasurement

Methods

createAnnotationMeasurement

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

deleteAnnotationMeasurement

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

updateAnnotationMeasurement

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