com.smartsheet.api

Interface CommentAttachmentResources

public interface CommentAttachmentResources

This interface provides methods to access CommentAttachment resources.

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

Method Summary

Modifier and Type	Method and Description
Attachment	attachFile(long sheetId, long commentId, File file, String contentType) Attach a file to a comment.
Attachment	attachUrl(long sheetId, long commentId, Attachment attachment) Attach a URL to a comment.

Method Detail

attachUrl

Attachment attachUrl(long sheetId,
                     long commentId,
                     Attachment attachment)
              throws SmartsheetException

Attach a URL to a comment.

The URL can be a normal URL (attachmentType "URL"), a Google Drive URL (attachmentType "GOOGLE_DRIVE") or a Box.com URL (attachmentType "BOX_COM").

It mirrors to the following Smartsheet REST API method:

POST /sheets/{sheetId}/comments/{commentId}/attachments

Parameters:

sheetId - the sheet id

commentId - the comment id

attachment - the attachment object

Returns:

the created attachment

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

attachFile

Attachment attachFile(long sheetId,
                      long commentId,
                      File file,
                      String contentType)
               throws FileNotFoundException,
                      SmartsheetException

Attach a file to a comment.

It mirrors to the following Smartsheet REST API method:

POST /sheets/{sheetId}/comments/{commentId}/attachments

Parameters:

sheetId - the id of the sheet

commentId - the id of the comment

file - the file to attach

contentType - the content type of the file

Returns:

the created attachment

Throws:

FileNotFoundException - the file not found exception

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation