Interface AnnotationCoreServiceInterface

interface AnnotationCoreServiceInterface {
    deleteAnnotation(
        id: Annotation.AnnotationId,
    ): Promise<DeleteAnnotationResult>;
    uploadThumbnail(
        annotationId: Annotation.AnnotationId,
        thumbnail: Blob,
    ): Promise<CreateAnnotationThumbnailResult>;
}

Implemented by

AnnotationCoreService

Index

Methods

deleteAnnotation uploadThumbnail

Methods

deleteAnnotation

deleteAnnotation(id: Annotation.AnnotationId): Promise<DeleteAnnotationResult>
Delete an annotation by its id.
Parameters
- id: Annotation.AnnotationId
Returns Promise<DeleteAnnotationResult>
- Defined in service/annotationCoreServiceInterface.ts:21

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>
- Defined in service/annotationCoreServiceInterface.ts:28