Class AnnotationCoreService

Core annotation operations.

Implements

AnnotationCoreServiceInterface

Index

Constructors

Methods

deleteAnnotation uploadThumbnail

Constructors

constructor

new AnnotationCoreService(
connectClient: ConnectClientInterface,
): AnnotationCoreService
Parameters
- connectClient: ConnectClientInterface
  Connect client to make API calls from the Connect SDK
Returns AnnotationCoreService
- Defined in service/annotationCoreService.ts:19

Methods

deleteAnnotation

deleteAnnotation(id: Annotation.AnnotationId): Promise<DeleteAnnotationResult>
Delete an annotation by its id.
Parameters
- id: Annotation.AnnotationId
Returns Promise<DeleteAnnotationResult>
Implementation of AnnotationCoreServiceInterface.deleteAnnotation
- Defined in service/annotationCoreService.ts:24

uploadThumbnail

uploadThumbnail(
annotationId: Annotation.AnnotationId,
thumbnail: Blob,
): Promise<CreateAnnotationThumbnailResult>
Upload a thumbnail for an annotation.
Parameters
- annotationId: Annotation.AnnotationId
  The id of the annotation to upload the thumbnail for.
- thumbnail: Blob
  The thumbnail blob to upload.
Returns Promise<CreateAnnotationThumbnailResult>
Implementation of AnnotationCoreServiceInterface.uploadThumbnail
- Defined in service/annotationCoreService.ts:45