Interface HomeFolderResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
This interface provides methods to access Folder resources under home.
Thread Safety: Implementation of this interface must be thread safe.
public interface HomeFolderResourcesMethods
CreateFolder(Folder)
Create a folder in home.
It mirrors to the following Smartsheet REST API method:
POST /home/Folders
Folder CreateFolder(Folder folder)Parameters
folderFolderthe folder to create
Returns
- Folder
the folder
Exceptions
- InvalidOperationException
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
ListFolders(PaginationParameters?)
List Folders under home.
It mirrors to the following Smartsheet REST API method:
GET /home/Folders
PaginatedResult<Folder> ListFolders(PaginationParameters? paging = null)Parameters
pagingPaginationParameters
Returns
- PaginatedResult<Folder>
the list of Folders (note that an empty list will be returned if no child folder is found), limited to the following attributes:
- id
- name
- permalink
Exceptions
- InvalidOperationException
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