Skip to content

Latest commit

 

History

History
181 lines (117 loc) · 4.92 KB

Comments.md

File metadata and controls

181 lines (117 loc) · 4.92 KB
Raw

ICommentsManager

List file comments

Retrieves a list of comments for a file.

This operation is performed by calling function GetFileComments.

See the endpoint docs at API Reference.

await client.Comments.GetFileCommentsAsync(fileId: fileId);

Arguments

  • fileId string
    • The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Example: "12345"
  • queryParams GetFileCommentsQueryParams
    • Query parameters of getFileComments method
  • headers GetFileCommentsHeaders
    • Headers of getFileComments method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type Comments.

Returns a collection of comment objects. If there are no comments on this file an empty collection will be returned.

Get comment

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

This operation is performed by calling function GetCommentById.

See the endpoint docs at API Reference.

await client.Comments.GetCommentByIdAsync(commentId: NullableUtils.Unwrap(newComment.Id));

Arguments

  • commentId string
    • The ID of the comment. Example: "12345"
  • queryParams GetCommentByIdQueryParams
    • Query parameters of getCommentById method
  • headers GetCommentByIdHeaders
    • Headers of getCommentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type CommentFull.

Returns a full comment object.

Update comment

Update the message of a comment.

This operation is performed by calling function UpdateCommentById.

See the endpoint docs at API Reference.

await client.Comments.UpdateCommentByIdAsync(commentId: NullableUtils.Unwrap(newReplyComment.Id), requestBody: new UpdateCommentByIdRequestBody() { Message = newMessage });

Arguments

  • commentId string
    • The ID of the comment. Example: "12345"
  • requestBody UpdateCommentByIdRequestBody
    • Request body of updateCommentById method
  • queryParams UpdateCommentByIdQueryParams
    • Query parameters of updateCommentById method
  • headers UpdateCommentByIdHeaders
    • Headers of updateCommentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type CommentFull.

Returns the updated comment object.

Remove comment

Permanently deletes a comment.

This operation is performed by calling function DeleteCommentById.

See the endpoint docs at API Reference.

await client.Comments.DeleteCommentByIdAsync(commentId: NullableUtils.Unwrap(newComment.Id));

Arguments

  • commentId string
    • The ID of the comment. Example: "12345"
  • headers DeleteCommentByIdHeaders
    • Headers of deleteCommentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type null.

Returns an empty response when the comment has been deleted.

Create comment

Adds a comment by the user to a specific file, or as a reply to an other comment.

This operation is performed by calling function CreateComment.

See the endpoint docs at API Reference.

await client.Comments.CreateCommentAsync(requestBody: new CreateCommentRequestBody(message: message, item: new CreateCommentRequestBodyItemField(id: NullableUtils.Unwrap(newComment.Id), type: CreateCommentRequestBodyItemTypeField.Comment)));

Arguments

  • requestBody CreateCommentRequestBody
    • Request body of createComment method
  • queryParams CreateCommentQueryParams
    • Query parameters of createComment method
  • headers CreateCommentHeaders
    • Headers of createComment method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type CommentFull.

Returns the newly created comment object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.