Package com.smartsheet.api.models

Class Workspace

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<java.lang.Long>

com.smartsheet.api.models.Folder

com.smartsheet.api.models.Workspace

public class Workspace
extends Folder

Represents the Workspace object which is an area in which sheets, reports, templates and sub-folders can be organized, similar to a folder.

See Also:

Help Creating a Workspace

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Workspace.UpdateWorkspaceBuilder	A convenience class for creating a Workspace object with the appropriate fields for updating a workspace.

Nested classes/interfaces inherited from class com.smartsheet.api.models.Folder

Folder.CreateFolderBuilder, Folder.UpdateFolderBuilder

Constructor Summary

Constructors

Constructor	Description
Workspace()

Method Summary

Modifier and Type	Method	Description
AccessLevel	getAccessLevel()	Gets the user's permissions on a workspace.
java.lang.Boolean	getFavorite()	Deprecated, for removal: This API element is subject to removal in a future version. As of API 3.2.2.
java.lang.String	getPermalink()	Gets the permalink to the workspace.
Workspace	setAccessLevel(AccessLevel accessLevel)	Sets the user's permissions on a workspace.
Folder	setFavorite(java.lang.Boolean favorite)	Deprecated, for removal: This API element is subject to removal in a future version. As of API 3.2.2.
Folder	setPermalink(java.lang.String permalink)	Sets the permalink to the workspace.

Methods inherited from class com.smartsheet.api.models.Folder

getCreatedAt, getFolders, getModifiedAt, getReports, getSheets, getSights, getSource, getTemplates, setCreatedAt, setFolders, setModifiedAt, setName, setReports, setSheets, setSights, setSource, setTemplates

Methods inherited from class com.smartsheet.api.models.NamedModel

getName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Workspace

public Workspace()

Method Detail

getAccessLevel

public AccessLevel getAccessLevel()

Gets the user's permissions on a workspace.

Returns:

the access level

setAccessLevel

public Workspace setAccessLevel(AccessLevel accessLevel)

Sets the user's permissions on a workspace.

Parameters:

accessLevel - the new access level

getPermalink

public java.lang.String getPermalink()

Gets the permalink to the workspace.

Overrides:

getPermalink in class Folder

Returns:

the permalink

setPermalink

public Folder setPermalink(java.lang.String permalink)

Sets the permalink to the workspace.

Overrides:

setPermalink in class Folder

Parameters:

permalink - the new permalink

getFavorite

@Deprecated(since="3.2.2",
            forRemoval=true)
public java.lang.Boolean getFavorite()

Deprecated, for removal: This API element is subject to removal in a future version.

As of API 3.2.2. Please use the isFavorite method in FavoritesResources instead.

Gets the favorite

Overrides:

getFavorite in class Folder

Returns:

the favorite

setFavorite

@Deprecated(since="3.2.2",
            forRemoval=true)
public Folder setFavorite(java.lang.Boolean favorite)

Deprecated, for removal: This API element is subject to removal in a future version.

As of API 3.2.2. Please use the isFavorite method in FavoritesResources instead.

Sets the favorite

Overrides:

setFavorite in class Folder

Parameters:

favorite - the favorite