Package com.smartsheet.api

Interface HomeFolderResources

  • @Deprecated(since="3.4.0",
            forRemoval=true)
public interface HomeFolderResources
    Deprecated, for removal: This API element is subject to removal in a future version.
    Home resources have been deprecated and will be removed in a future version.

    This interface provides methods to access Folder resources under home.

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

    • Method Detail

      • listFolders

        @Deprecated(since="3.4.0",
            forRemoval=true)
PagedResult<Folder> listFolders​(PaginationParameters parameters)
                         throws SmartsheetException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Home resources have been deprecated and will be removed in a future version.

        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

        @Deprecated(since="3.4.0",
            forRemoval=true)
Folder createFolder​(Folder folder)
             throws SmartsheetException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Home resources have been deprecated and will be removed in a future version.

        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