com.smartsheet.api

Interface SheetCommentResources

public interface SheetCommentResources

This interface provides methods to access Sheet Comment resources.

Thread Safety: Implementation of this interface must be thread safe.

Method Summary

Modifier and Type	Method and Description
CommentAttachmentResources	attachmentResources() Creates an object of CommentAttachmentResources.
void	deleteComment(long sheetId, long commentId) Delete a comment.
Comment	getComment(long sheetId, long commentId) Get a comment.

Method Detail

getComment

Comment getComment(long sheetId,
                   long commentId)
            throws SmartsheetException

Get a comment.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/comments/{commentId}

Parameters:

sheetId - the ID of the sheet

commentId - the ID of the comment

Returns:

the comment (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).

Throws:

SmartsheetException - if there is any other error during the operation

deleteComment

void deleteComment(long sheetId,
                   long commentId)
            throws SmartsheetException

Delete a comment.

It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/comments/{commentId}

Parameters:

sheetId - the ID of the sheet

commentId - the ID of the comment

Throws:

SmartsheetException - if there is any other error during the operation

attachmentResources

CommentAttachmentResources attachmentResources()
                                        throws SmartsheetException

Creates an object of CommentAttachmentResources.

Returns:

the created attachment

Throws:

SmartsheetException - if there is any other error during the operation