Interface IThreadService

Provides methods for managing user subscriptions to annotation threads within a project.

Namespace: Unity.Cloud.Collaboration.Services.ThreadService

Assembly: Unity.Cloud.Collaboration.dll

Syntax

public interface IThreadService

Methods

IsSubscribedToThreadAsync(ProjectId, AnnotationId, CancellationToken)

Checks if the current user is subscribed to notifications for a specific annotation thread.

Declaration

Task<IsSubscribedToThreadResult> IsSubscribedToThreadAsync(ProjectId projectId, AnnotationId annotationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The ID of the project containing the annotation thread.
AnnotationId	annotationId	The ID of the annotation thread to check the subscription against.
CancellationToken	cancellationToken	Optional cancellation token to cancel the subscription request.

Returns

Type	Description
Task<IsSubscribedToThreadResult>	Task of IsSubscribedToThreadResult

SubscribeToThreadAsync(ProjectId, AnnotationId, CancellationToken)

Subscribes the current user to notifications for a specific annotation thread.

Declaration

Task SubscribeToThreadAsync(ProjectId projectId, AnnotationId annotationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The ID of the project containing the annotation thread.
AnnotationId	annotationId	The ID of the annotation thread to subscribe to.
CancellationToken	cancellationToken	Optional cancellation token to cancel the subscription request.

Returns

Type	Description
Task	Task of void

ThreadsCountByTargetAsync(ProjectId, string, int?, int?, CancellationToken)

Read group of targets/sub-targets count. Allows glob-like partial matching on the Target field

Declaration

Task<ThreadsCountByTargetResult> ThreadsCountByTargetAsync(ProjectId projectId, string target, int? offset = null, int? limit = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id
string	target	Threads matching the Target will be counted. Glob-like partial matching on the Target field is supported. This supports partial matching by using a wildcard() at the end of the target path. For example, retrieving array of targets/sub-targets count within a project can be done with: assets/projects//assets// Important limitations: - The wildcard must be at the end of the path. - Full wildcard within the path is not supported.
int?	offset	The amount of targets to skip
int?	limit	The page size
CancellationToken	cancellationToken	Cancellation Token to cancel the request

Returns

Type	Description
Task<ThreadsCountByTargetResult>	Task of ThreadsCountByTargetResult

ThreadsCountInAnnotationsByTargetAsync(ProjectId, string, CancellationToken)

Read threads count matching the target. Allows glob-like partial matching on the Target field.

Declaration

Task<ThreadsCountInAnnotationsByTargetResult> ThreadsCountInAnnotationsByTargetAsync(ProjectId projectId, string target, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id
string	target	Threads matching the Target will be counted. Glob-like partial matching on the Target field is supported. This supports partial matching by using a wildcard() at the end of the target path. For example, retrieving all threads count with sub targets within a project can be done with: assets/projects//assets// Important limitations: - The wildcard must be at the end of the path. - Full wildcard within the path is not supported.
CancellationToken	cancellationToken	Cancellation Token to cancel the request

Returns

Type	Description
Task<ThreadsCountInAnnotationsByTargetResult>	Task of ThreadsCountInAnnotationsByTargetResult

UnsubscribeFromThreadAsync(ProjectId, AnnotationId, CancellationToken)

Unsubscribes the current user from notifications for a specific annotation thread.

Declaration

Task UnsubscribeFromThreadAsync(ProjectId projectId, AnnotationId annotationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The ID of the project containing the annotation thread.
AnnotationId	annotationId	The ID of the annotation thread to unsubscribe from.
CancellationToken	cancellationToken	Optional cancellation token to cancel the subscription request.

Returns

Type	Description
Task	Task of void