Use case: Delete an annotation

Before you start

  1. Verify Permissions: Check that you have the required permissions to delete annotations. Typically, this requires either being the annotation creator or having administrator privileges.
  2. Identify the Annotation: Make sure you have the unique identifier of the annotation you wish to delete. You'll need this ID to reference the specific annotation in your deletion request.
  3. Consider Data Retention: Be aware that deleting an annotation is permanent and cannot be undone. Ensure you want to remove this content completely from the system.
  4. Check Dependencies: If the annotation has replies or attachments, understand how deletion might affect those related items. Some systems may require handling these dependencies before deletion.

How do I...?

Delete an annotation

To delete an annotation, follow these steps:

  1. Retrieve the Project ID: Before deletion, ensure you have the correct Project ID.
  2. Retrieve the Annotation ID: Before deletion, ensure you have the correct annotation ID. You can get this from search results or from a specific annotation view.
  3. Call the Delete Method: Use the SDK's delete method to remove the annotation from the system.
  4. Handle Confirmation and Errors: Your implementation should verify whether the deletion was successful and handle any potential errors appropriately.
  5. Update UI: If your application has a user interface displaying annotations, refresh the view to reflect the deletion.

Example:

await annotationManagement.DeleteAnnotationAsync(projectId, annotationId, cancellationToken);

For more information on managing annotations, refer to related documentation on Create an annotation or Update an annotation.