Use case: Subscribe a user to a thread

Before you start

Before you subscribe a user to a thread, ensure you have completed the following prerequisites:

  1. Verify Permissions: Confirm that you have the necessary rights to manage thread subscriptions. Typically, users can subscribe themselves, while administrators might be able to manage subscriptions for others.
  2. Identify the Thread: You must have a valid thread identifier for the thread to which you want to subscribe the user. Threads are typically identified by their root annotation ID or a dedicated thread ID.
  3. Identify the User: Determine which user should be subscribed to the thread. This could be the current user or another user (if you have administrative access).
  4. Understand Subscription Effects: Be aware that subscribing to a thread means the user will receive notifications about thread activity, such as new replies, status changes, or mentions.
  5. Set Up SDK Environment: Ensure your Unity environment is properly configured with the Collaboration SDK to interact with the thread subscription system.

How do I...?

Subscribe the current user to a thread

To subscribe the currently authenticated user to a specific thread:

  1. Obtain the Project Identifier: Ensure you have the correct project identifier (GUID) for the project.
  2. Obtain the Annotation Identifier: Ensure you have the correct annotation identifier (GUID) for the root annotation identifying the thread.
  3. Execute the Subscription: Use the SDK to subscribe the current user to the thread.
  4. Update UI: Modify your interface to indicate the user is now subscribed.

Example:

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

Thread subscriptions are an important mechanism for keeping team members informed about discussions that matter to them. Users who subscribe to threads will receive notifications when new replies are added, when the thread is resolved or reopened, or when other significant thread events occur, helping them stay connected to important conversations.

For more information on working with thread subscriptions, see the documentation on checking user subscription status and unsubscribing users from threads.