box-node-sdk

CommentsManager

• List file comments
• Get comment
• Update comment
• Remove comment
• Create comment

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.getFileComments(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”
• optionalsInput GetFileCommentsOptionalsInput

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.getCommentById(newComment.id!);

Arguments

• commentId string
  • The ID of the comment. Example: “12345”
• optionalsInput GetCommentByIdOptionalsInput

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.updateCommentById(newReplyComment.id!, {
  requestBody: { message: newMessage } satisfies UpdateCommentByIdRequestBody,
} satisfies UpdateCommentByIdOptionalsInput);

Arguments

• commentId string
  • The ID of the comment. Example: “12345”
• optionalsInput UpdateCommentByIdOptionalsInput

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.deleteCommentById(newComment.id!);

Arguments

• commentId string
  • The ID of the comment. Example: “12345”
• optionalsInput DeleteCommentByIdOptionalsInput

Returns

This function returns a value of type undefined.

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.createComment({
  message: message,
  item: {
    id: fileId,
    type: 'file' as CreateCommentRequestBodyItemTypeField,
  } satisfies CreateCommentRequestBodyItemField,
} satisfies CreateCommentRequestBody);

Arguments

• requestBody CreateCommentRequestBody
  • Request body of createComment method
• optionalsInput CreateCommentOptionalsInput

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.

This site is open source. Improve this page.