C# Class Smartsheet.Api.Internal.FolderResourcesImpl

This is the implementation of the FolderResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
Inheritance: AbstractResources, FolderResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method Description
CopyFolder ( long folderId, ContainerDestination destination, IEnumerable include, IEnumerable skipRemap ) : Folder

Creates a copy of the specified Folder.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/copy
CreateFolder ( long folderId, Folder folder ) : Folder

Creates a Folder in the specified Folder.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/folders
DeleteFolder ( long folderId ) : void

Deletes a folder.

It mirrors To the following Smartsheet REST API method:
DELETE /folders/{folderId}
FolderResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic

Constructor.
GetFolder ( long folderId, IEnumerable include ) : Folder

Gets the specified Folder (and lists its contents).

It mirrors To the following Smartsheet REST API method: GET /folders/{folderId}
ListFolders ( long folderId, PaginationParameters paging ) : PaginatedResult

Gets a list of the top-level child Folders within the specified Folder.

This operation supports pagination of results. For more information, see Paging.

It mirrors To the following Smartsheet REST API method:
GET /folders/{folderId}/folders
MoveFolder ( long folderId, ContainerDestination destination ) : Folder

Moves the specified Folder to another location.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/move
UpdateFolder ( Folder folder ) : Folder

Updates a folder.

It mirrors To the following Smartsheet REST API method: PUT /folders/{folderId}

Method Details

CopyFolder() public method

Creates a copy of the specified Folder.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/copy

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public CopyFolder ( long folderId, ContainerDestination destination, IEnumerable include, IEnumerable skipRemap ) : Folder
folderId long the folder Id
destination ContainerDestination the destination to copy to
include IEnumerable the elements to copy. Note: Cell history will not be copied, regardless of which include parameter values are specified.
skipRemap IEnumerable the references to NOT re-map for the newly created folder /// /// If “cellLinks” is specified in the skipRemap parameter value, the cell links within the newly created folder will continue to point to the original source sheets. /// If “reports” is specified in the skipRemap parameter value, the reports within the newly created folder will continue to point to the original source sheets. /// ///
return Folder

CreateFolder() public method

Creates a Folder in the specified Folder.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/folders

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public CreateFolder ( long folderId, Folder folder ) : Folder
folderId long the parent folder Id
folder Folder the folder To create
return Folder

DeleteFolder() public method

Deletes a folder.

It mirrors To the following Smartsheet REST API method:
DELETE /folders/{folderId}

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public DeleteFolder ( long folderId ) : void
folderId long the folder Id
return void

FolderResourcesImpl() public method

Constructor.
if any argument is null
public FolderResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
smartsheet SmartsheetImpl the SmartsheetImpl
return System.Collections.Generic

GetFolder() public method

Gets the specified Folder (and lists its contents).

It mirrors To the following Smartsheet REST API method: GET /folders/{folderId}

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public GetFolder ( long folderId, IEnumerable include ) : Folder
folderId long the folder Id
include IEnumerable (optional) – comma-separated list of elements to include in the respons
return Folder

ListFolders() public method

Gets a list of the top-level child Folders within the specified Folder.

This operation supports pagination of results. For more information, see Paging.

It mirrors To the following Smartsheet REST API method:
GET /folders/{folderId}/folders

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ListFolders ( long folderId, PaginationParameters paging ) : PaginatedResult
folderId long the folderId
paging PaginationParameters the pagination information
return PaginatedResult

MoveFolder() public method

Moves the specified Folder to another location.

It mirrors To the following Smartsheet REST API method:
POST /folders/{folderId}/move

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public MoveFolder ( long folderId, ContainerDestination destination ) : Folder
folderId long the folder Id
destination ContainerDestination the destination to copy to
return Folder

UpdateFolder() public method

Updates a folder.

It mirrors To the following Smartsheet REST API method: PUT /folders/{folderId}

if any argument is null or empty string 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 cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public UpdateFolder ( Folder folder ) : Folder
folder Folder the folder To update
return Folder