Interface IAttachmentService

Provides methods for managing annotation attachments within a project.

Namespace: Unity.Cloud.Collaboration.Services.AttachmentService

Assembly: Unity.Cloud.Collaboration.dll

Syntax

public interface IAttachmentService

Methods

CreateAnnotationAttachmentAsync(ProjectId, AnnotationId, ICreateAttachmentRequest, CancellationToken)

Create annotation attachment

Declaration

Task<CreateAnnotationAttachmentResult> CreateAnnotationAttachmentAsync(ProjectId projectId, AnnotationId annotationId, ICreateAttachmentRequest requestModel, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
ICreateAttachmentRequest	requestModel	The request containing the information of the Annotation Attachment to be created
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CreateAnnotationAttachmentResult>	Task of CreateAnnotationAttachmentResult

Remarks

Creates a new annotation attachment.

DeleteAttachmentAsync(ProjectId, AnnotationId, AttachmentId, CancellationToken)

Delete Attachment.

Declaration

Task DeleteAttachmentAsync(ProjectId projectId, AnnotationId annotationId, AttachmentId attachmentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project Id.
AnnotationId	annotationId	The annotation Id.
AttachmentId	attachmentId	The attachment Id.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Delete an attachment from an annotation in project.

FinalizeAnnotationAttachmentAsync(ProjectId, AnnotationId, AttachmentId, string, CancellationToken)

Finalize annotation attachment

Declaration

Task FinalizeAnnotationAttachmentAsync(ProjectId projectId, AnnotationId annotationId, AttachmentId attachmentId, string filePath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
AttachmentId	attachmentId	The attachment id.
string	filePath	The file path of the attachment to be finalized
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Finalizes an annotation attachment.

ReadAnnotationAttachmentFileUploadUrlAsync(ProjectId, AnnotationId, AttachmentId, string, CancellationToken)

Reads the upload URL for an annotation attachment file.

Declaration

Task<ReadAnnotationAttachmentFileUploadUrlResult> ReadAnnotationAttachmentFileUploadUrlAsync(ProjectId projectId, AnnotationId annotationId, AttachmentId attachmentId, string filePath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The Project ID.
AnnotationId	annotationId	The ID of the annotation to which the attachment belongs.
AttachmentId	attachmentId	The ID of the attachment.
string	filePath	The file path for the attachment (optional).
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ReadAnnotationAttachmentFileUploadUrlResult>	Task representing the operation to fetch the file upload URL.

ReadAnnotationFileAttachmentDownloadUrlAsync(ProjectId, AnnotationId, AttachmentId, string, int?, CancellationToken)

Reads the download URL for an annotation attachment file.

Declaration

Task<ReadAnnotationFileAttachmentDownloadUrlResult> ReadAnnotationFileAttachmentDownloadUrlAsync(ProjectId projectId, AnnotationId annotationId, AttachmentId attachmentId, string filePath = null, int? width = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The Project ID.
AnnotationId	annotationId	The ID of the annotation to which the attachment belongs.
AttachmentId	attachmentId	The ID of the attachment.
string	filePath	The file path for the attachment (optional).
int?	width	The width for the attachment (optional).
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ReadAnnotationFileAttachmentDownloadUrlResult>	Task representing the operation to fetch the file download URL.

UpdateAnnotationAttachmentAsync(ProjectId, AnnotationId, AttachmentId, IUpdateAttachmentRequest, CancellationToken)

Update annotation attachment

Declaration

Task UpdateAnnotationAttachmentAsync(ProjectId projectId, AnnotationId annotationId, AttachmentId attachmentId, IUpdateAttachmentRequest requestModel, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
AttachmentId	attachmentId	The attachment id.
IUpdateAttachmentRequest	requestModel	The request containing the information of the Annotation Attachment to be updated
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Updates an annotation attachment.