com.smartsheet.api

Interface HomeResources

public interface HomeResources

This interface provides methods to access Home resources.

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

Method Summary

Modifier and Type	Method and Description
HomeFolderResources	folderResources() Return the HomeFolderResources object that provides access to Folder resources under home.
Home	getHome(EnumSet<SourceInclusion> includes) Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or templates, as shown on the Home tab.
Home	getHome(EnumSet<SourceInclusion> includes, EnumSet<SourceExclusion> excludes) Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or templates, as shown on the Home tab.

Method Detail

getHome

Home getHome(EnumSet<SourceInclusion> includes)
      throws SmartsheetException

Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or templates, as shown on the Home tab.

It mirrors to the following Smartsheet REST API method: GET /home

Parameters:

includes - used to specify the optional objects to include.

Returns:

the home resource (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

getHome

Home getHome(EnumSet<SourceInclusion> includes,
             EnumSet<SourceExclusion> excludes)
      throws SmartsheetException

Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or templates, as shown on the Home tab.

It mirrors to the following Smartsheet REST API method: GET /home

Parameters:

includes - used to specify the optional objects to include.

excludes - used to specify the optional objects to exclude.

Returns:

the home resource (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

folderResources

HomeFolderResources folderResources()

Return the HomeFolderResources object that provides access to Folder resources under home.

Returns:

the home folder resources