com.smartsheet.api

Interface RowDiscussionResources

public interface RowDiscussionResources

This interface provides methods to access Row Discussion resources.

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

Method Summary

Modifier and Type	Method and Description
Discussion	createDiscussion(long sheetId, long rowId, Discussion discussion) Create discussion on a row.
Discussion	createDiscussionWithAttachment(long sheetId, long rowId, Discussion discussion, File file, String contentType) Create discussion on a row.
PagedResult<Discussion>	listDiscussions(long sheetId, long rowId, PaginationParameters pagination, EnumSet<DiscussionInclusion> includes) Gets a list of all Discussions associated with the specified Row.

Method Detail

createDiscussion

Discussion createDiscussion(long sheetId,
                            long rowId,
                            Discussion discussion)
                     throws SmartsheetException

Create discussion on a row.

It mirrors to the following Smartsheet REST API method: /sheets/{sheetId}/rows/{rowId}/discussions

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

rowId - the row ID

discussion - the comment to add, limited to the following required attributes: text

Returns:

the created comment

Throws:

SmartsheetException - the smartsheet exception

listDiscussions

PagedResult<Discussion> listDiscussions(long sheetId,
                                        long rowId,
                                        PaginationParameters pagination,
                                        EnumSet<DiscussionInclusion> includes)
                                 throws SmartsheetException

Gets a list of all Discussions associated with the specified Row.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/discussions

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

rowId - the row ID

pagination - the pagination pagination

includes - the optional include parameters

Returns:

the row discussions

Throws:

SmartsheetException - the smartsheet exception

createDiscussionWithAttachment

Discussion createDiscussionWithAttachment(long sheetId,
                                          long rowId,
                                          Discussion discussion,
                                          File file,
                                          String contentType)
                                   throws SmartsheetException,
                                          IOException

Create discussion on a row.

It mirrors to the following Smartsheet REST API method: /sheets/{sheetId}/rows/{rowId}/discussions

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

rowId - the row ID

discussion - the comment to add, limited to the following required attributes: text

file - the file to be attached

contentType - the type of file

Returns:

the created discussion

Throws:

SmartsheetException - the smartsheet exception

IOException - is there is an I/O exception