C# Class Smartsheet.Api.Internal.HomeResourcesImpl

This is the implementation of the HomeResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.

Inheritance: AbstractResources, HomeResources

Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method	Description
GetHome ( IEnumerable includes ) : Api.Models.Home	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
HomeResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic	Constructor. Exceptions: - IllegalArgumentException : if any argument is null

Method Details

GetHome() public method

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

if there is any problem with the REST API request if there is any problem with the REST API authorization(access token) if the resource can not be found if the REST API service is not available (possibly due To rate limiting) if there is any other REST API related error occurred during the operation if there is any other error occurred during the operation

public GetHome ( IEnumerable includes ) : Api.Models.Home
includes	IEnumerable	used To specify the optional objects To include, currently TEMPLATES is supported.
return	Api.Models.Home

HomeResourcesImpl() public method

Constructor. Exceptions: - IllegalArgumentException : if any argument is null

public HomeResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
smartsheet	SmartsheetImpl	the Smartsheet
return	System.Collections.Generic