Package com.smartsheet.api

Interface HomeFolderResources

public interface HomeFolderResources

This interface provides methods to access Folder resources under home.

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

Method Summary

Modifier and Type	Method	Description
Folder	createFolder(Folder folder)	Create a folder in home.
PagedResult<Folder>	listFolders(PaginationParameters parameters)	List folders under home.

Method Detail

listFolders

PagedResult<Folder> listFolders(PaginationParameters parameters)
                         throws SmartsheetException

List folders under home.

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

Parameters:

parameters - the pagination parameters

Returns:

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

Throws:

java.lang.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

createFolder

Folder createFolder(Folder folder)
             throws SmartsheetException

Create a folder in home.

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

Parameters:

folder - the folder to create

Returns:

the folder

Throws:

java.lang.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