com.smartsheet.api

Interface ShareResources

public interface ShareResources

This interface provides methods to access Share resources.

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

Method Summary

Modifier and Type	Method and Description
void	deleteShare(long objectId, String shareId) Delete a share.
Share	getShare(long objectId, String shareId) Get a Share.
PagedResult<Share>	listShares(long objectId, PaginationParameters parameters) Deprecated.
PagedResult<Share>	listShares(long objectId, PaginationParameters parameters, Boolean includeWorkspaceShares) List shares of a given object.
List<Share>	shareTo(long objectId, List<Share> shares, Boolean sendEmail) Shares the object with the specified Users and Groups.
Share	updateShare(long objectId, Share share) Update a share.

Method Detail

listShares

@Deprecated
PagedResult<Share> listShares(long objectId,
                                          PaginationParameters parameters)
                                   throws SmartsheetException

Deprecated.

List shares of a given object.

It mirrors to the following Smartsheet REST API method:

GET /workspace/{id}/shares

GET /sheet/{id}/shares

Parameters:

objectId - the object id

parameters - the pagination parameters

Returns:

the list of Share objects (note that an empty list will be returned if there is none).

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

listShares

PagedResult<Share> listShares(long objectId,
                              PaginationParameters parameters,
                              Boolean includeWorkspaceShares)
                       throws SmartsheetException

List shares of a given object.

It mirrors to the following Smartsheet REST API method:

GET /workspace/{id}/shares

GET /sheet/{id}/shares

Parameters:

objectId - the object id

parameters - the pagination parameters

includeWorkspaceShares - include workspace shares in enumeration

Returns:

the list of Share objects (note that an empty list will be returned if there is none).

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

getShare

Share getShare(long objectId,
               String shareId)
        throws SmartsheetException

Get a Share.

It mirrors to the following Smartsheet REST API method:

GET /workspaces/{workspaceId}/shares/{shareId}

GET /sheets/{sheetId}/shares/{shareId}

GET /reports/{reportId}/shares

Exceptions: 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 can not be found 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:

objectId - the ID of the object to share

shareId - the ID of the share

Returns:

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

Throws:

SmartsheetException - the smartsheet exception

shareTo

List<Share> shareTo(long objectId,
                    List<Share> shares,
                    Boolean sendEmail)
             throws SmartsheetException

Shares the object with the specified Users and Groups.

It mirrors to the following Smartsheet REST API method:

POST /workspaces/{id}/shares

POST /sheets/{id}/shares

POST /reports/{reportId}/shares

Exceptions: IllegalArgumentException : if multiShare 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) ResourceNotFoundException : if the resource can not be found 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:

objectId - the ID of the object to share

shares - list of share objects

sendEmail - whether to send email

Returns:

the created shares

Throws:

SmartsheetException - the smartsheet exception

updateShare

Share updateShare(long objectId,
                  Share share)
           throws SmartsheetException

Update a share.

It mirrors to the following Smartsheet REST API method:

PUT /workspaces/{workspaceId}/shares/{shareId}

PUT /sheets/{sheetId}/shares/{shareId}

PUT /reports/{reportId}/shares/{shareId}

Parameters:

objectId - the ID of the object to share

share - the share

Returns:

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

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

deleteShare

void deleteShare(long objectId,
                 String shareId)
          throws SmartsheetException

Delete a share.

It mirrors to the following Smartsheet REST API method:

DELETE /workspaces/{workspaceId}/shares/{shareId}

DELETE /sheets/{sheetId}/shares/{shareId}

DELETE /reports/{reportId}/shares/{shareId}

Exceptions: 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 can not be found 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:

objectId - the ID of the object to share

shareId - the ID of the share to delete

Throws:

SmartsheetException - the smartsheet exception