Sample: Annotation Manager

Use the Annotation Manager sample to create, read, update annotations, add and remove attachments, subscribe and unsubscribe threads, in your Unity project.

Note

To use Collaboration, you need the Asset Manager Consumer permissions at project level.

Before you start

Before you use the Annotation Manager sample, make sure you have the following:

• An installed Collaboration package.
• An installed Assets package.
• An installed Identity package.
• A valid Unity ID account.
• Access to your Unity Gaming Services account.
• Access to the Asset Manager service.
• A Unity project with the Asset Manager service enabled. Read more about creating a Unity project.

Note

Although the Collaboration package does not depend on the Identity service, the sample uses the service to control the authentication process.

Install the sample

To install the sample, follow these steps:

1. In the Unity Editor, go to Window > Package Manager > Unity Cloud Collaboration.

2. Expand the Samples section.

3. Select Import next to Annotation Manager.

4. After the import process completes, check the imported sample in the Assets/Samples/Unity Cloud Collaboration/<package-version>/Annotation Manager/Scenes/AnnotationManagerSample.unity folder.

Run the sample

To run the sample, follow these steps:

1. Go to Packages/Unity Cloud Collaboration/Samples/Annotation Manager/Scenes/AnnotationManagerSample.unity and run the scene.

Login

To log in to the sample, follow these steps:

1. Click the Login button in the top right corner of the window.

2. A login window appears. Enter your Unity ID credentials and click Sign In.

3. After you log in, the sample retrieves the list of organizations you have access to.

Select an organization and a project

1. Select an organization from the list on the left side of the window.
2. Select a project from the list of projects. The sample retrieves the list of annotations for that project.

Create an annotation

1. Type the annotation text in the text field at the bottom of the window.

2. Optionally, add an attachment by clicking the Add Attachment button and selecting a file from your computer.

3. Optionally, add some metadata by clicking the Add Metadata button and entering key-value pairs.

4. Click the Create Annotation button to create the annotation.

Add a reaction

1. Select an annotation from the list.
2. Click on one of the reaction buttons to add a reaction to the annotation. Clicking the same button again removes the reaction.