| Package | Description |
|---|---|
| com.smartsheet.api | |
| com.smartsheet.api.models |
| Modifier and Type | Method and Description |
|---|---|
Folder |
FolderResources.copyFolder(long folderId,
ContainerDestination containerDestination,
EnumSet<FolderCopyInclusion> includes,
EnumSet<FolderRemapExclusion> skipRemap)
Creates a copy of the specified Folder.
|
Folder |
FolderResources.copyFolder(long folderId,
ContainerDestination containerDestination,
EnumSet<FolderCopyInclusion> includes,
EnumSet<FolderRemapExclusion> skipRemap,
EnumSet<CopyExclusion> excludes)
Deprecated.
|
Folder |
HomeFolderResources.createFolder(Folder folder)
Create a folder in home.
|
Folder |
FolderResources.createFolder(long parentFolderId,
Folder folder)
Create a folder.
|
Folder |
WorkspaceFolderResources.createFolder(long workspaceId,
Folder folder)
Create a folder in the workspace.
|
Folder |
FolderResources.getFolder(long folderId,
EnumSet<SourceInclusion> includes)
Get a folder.
|
Folder |
FolderResources.moveFolder(long folderId,
ContainerDestination containerDestination)
Moves the specified Folder to another location.
|
Folder |
FolderResources.updateFolder(Folder folder)
Update a folder.
|
| Modifier and Type | Method and Description |
|---|---|
PagedResult<Folder> |
FolderResources.listFolders(long parentFolderId,
PaginationParameters parameters)
List child folders of a given folder.
|
PagedResult<Folder> |
WorkspaceFolderResources.listFolders(long workspaceId,
PaginationParameters parameters)
List folders of a given workspace.
|
PagedResult<Folder> |
HomeFolderResources.listFolders(PaginationParameters parameters)
List folders under home.
|
| Modifier and Type | Method and Description |
|---|---|
Folder |
HomeFolderResources.createFolder(Folder folder)
Create a folder in home.
|
Folder |
FolderResources.createFolder(long parentFolderId,
Folder folder)
Create a folder.
|
Folder |
WorkspaceFolderResources.createFolder(long workspaceId,
Folder folder)
Create a folder in the workspace.
|
Folder |
FolderResources.updateFolder(Folder folder)
Update a folder.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Workspace
Represents the Workspace object which is an area in which sheets, reports, templates and sub-folders can be
organized, similar to a folder.
|
| Modifier and Type | Method and Description |
|---|---|
Folder |
Folder.UpdateFolderBuilder.build()
Builds the folder.
|
Folder |
Folder.CreateFolderBuilder.build()
Builds the folder.
|
Folder |
Workspace.setFavorite(Boolean favorite)
Sets the favorite
|
Folder |
Folder.setFavorite(Boolean favorite)
Sets the favorite boolean value of folder in Home.
|
Folder |
Folder.setFolders(List<Folder> folders)
Sets the folders contained in this folder.
|
Folder |
Folder.setName(String name)
Provide an 'override' of setName (returns Folder not NamedModel)
|
Folder |
Workspace.setPermalink(String permalink)
Sets the permalink to the workspace.
|
Folder |
Folder.setPermalink(String permalink)
Sets the Direct URL to Folder.
|
Folder |
Folder.setReports(List<Report> reports)
Sets the reports.
|
Folder |
Folder.setSheets(List<Sheet> sheets)
Sets the sheets contained in the folder.
|
Folder |
Folder.setSights(List<Sight> sights)
Sets the sights contained in this folder.
|
Folder |
Folder.setTemplates(List<Template> templates)
Sets the templates contained in this folder.
|
| Modifier and Type | Method and Description |
|---|---|
List<Folder> |
Folder.getFolders()
Gets the folders contained in this folder.
|
List<Folder> |
Home.getFolders()
Gets the folders in the home location.
|
| Modifier and Type | Method and Description |
|---|---|
Folder |
Folder.setFolders(List<Folder> folders)
Sets the folders contained in this folder.
|
Home |
Home.setFolders(List<Folder> folders)
Sets the folders in the home location.
|
Copyright © 2014–2019 Smartsheet. All rights reserved.