Interface HomeResources

Namespace

Smartsheet.Api

Assembly

smartsheet-csharp-sdk.dll

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

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

[Obsolete("HomeResources is deprecated. Please use the specific resource endpoints instead: FolderResources.cs for GET /folders calls, SightResources.cs for GET /sights, ReportResources.cs for GET /reports, TemplateResources.cs for GET /templates and SheetResources.cs for GET /sheets.")]
public interface HomeResources

Properties

FolderResources

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

HomeFolderResources FolderResources { get; }

Property Value

HomeFolderResources

the home folder resources

Methods

GetFoldersPersonal(IEnumerable<HomeInclusion>)

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

[Obsolete("This method is deprecated. Please use the following alternatives instead: GET /folders to list folders, GET /folders/{folderId} to fetch folder children, GET /sights for dashboards, GET /reports for reports, GET /sheets for sheets, GET /templates for user-created templates, and GET /templates/public for public templates.")]
PersonalFolder GetFoldersPersonal(IEnumerable<HomeInclusion> includes)

Parameters

includes IEnumerable<HomeInclusion>

used to specify the optional objects to include, currently TEMPLATES is supported.

Returns

PersonalFolder

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

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)

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

GetFoldersPersonal(IEnumerable<HomeInclusion>?, IEnumerable<HomeExclusion>?)

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

[Obsolete("This method is deprecated. Please use the following alternatives instead: GET /folders to list folders, GET /folders/{folderId} to fetch folder children, GET /sights for dashboards, GET /reports for reports, GET /sheets for sheets, GET /templates for user-created templates, and GET /templates/public for public templates.")]
PersonalFolder GetFoldersPersonal(IEnumerable<HomeInclusion>? includes = null, IEnumerable<HomeExclusion>? excludes = null)

Parameters

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

Returns

PersonalFolder

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

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)

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