Interface HomeResources

This interface provides methods to access resources previously from the deprecated home API.

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

public interface HomeResources

Properties

Returns the HomeFolderResources object that provides access to folder resources under home.

HomeFolderResources FolderResources { get; }

Gets a nested list of shared items that were previously found from the /home API, including reports, sheets, templates, and dashboards.

Mirrors to the following Smartsheet REST API method: GET /home

PersonalFolder GetFoldersPersonal(IEnumerable<HomeInclusion> includes)

includes IEnumerable<HomeInclusion>: used to specify the optional objects to include, currently TEMPLATES is supported.

PersonalFolder: the resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning 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)
InvalidRequestException: if the resource cannot be found
ResourceNotFoundException: if the REST API service is not available (possibly due to rate limiting)
ServiceUnavailableException: if any other REST API related error occurred during the operation
SmartsheetException: if any other error occurred during the operation

Gets a nested list of shared items that were previously found from the /home API, including reports, sheets, templates, and dashboards.

Mirrors to the following Smartsheet REST API method: GET /folders/personal

PersonalFolder GetFoldersPersonal(IEnumerable<HomeInclusion>? includes = null, IEnumerable<HomeExclusion>? excludes = null)

includes IEnumerable<HomeInclusion>: used to specify the optional objects to include, currently TEMPLATES is supported.
excludes IEnumerable<HomeExclusion>: used to specify the optional object to exclude

PersonalFolder: the resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning 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)
InvalidRequestException: if the resource cannot be found
ResourceNotFoundException: if the REST API service is not available (possibly due to rate limiting)
ServiceUnavailableException: if any other REST API related error occurred during the operation
SmartsheetException: if any other error occurred during the operation