Use case: Resolve an annotation

Before you start

Before you resolve an annotation, ensure you have completed the following prerequisites:

  1. Verify Permissions: Check that you have the necessary permissions to modify the status of annotations. This typically requires being the annotation creator, assigned reviewer, or having appropriate administrator privileges.
  2. Locate the Annotation: Identify the specific annotation you want to resolve. You'll need its unique identifier to perform the resolution action.
  3. Understand Resolution Implications: Be aware that resolving an annotation typically indicates that the discussion or issue raised in the annotation has been addressed or completed. This status change may affect workflows and notifications in your project.
  4. Review Thread Completeness: Before resolving, consider whether all necessary discussions have taken place and confirm that the annotation's purpose has been fulfilled.
  5. Set Up SDK Environment: Ensure your Unity environment is properly configured with the Collaboration SDK to interact with the annotation system.

How do I...?

Resolve a single annotation

To mark an annotation as resolved, follow these steps:

  1. Prepare the Project Identifier: Ensure you have the correct project identifier (GUID) for the project you want to search for.
  2. Obtain the Annotation ID: Identify the unique identifier of the annotation you want to resolve.
  3. Handle Response: Verify that the resolution was successful and handle any errors appropriately.
  4. Update UI: If your application has a user interface displaying annotations, refresh it to reflect the resolved status of the annotation.

Example:

await annotationManagement.ResolveAnnotationAsync(
   projectId: projectId,
   annotationId: annotationId,
   cancellationToken: cancellationToken);
Note

Resolved annotations typically remain accessible in the system for reference purposes but may be filtered differently in search results and UI views. This behavior helps maintain a record of discussions while keeping active items prominently visible.

For more comprehensive annotation management, see the full range of annotation operations in the Table of Contents under the Annotations section.