Package com.smartsheet.api.models
Class Sight
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.Sight
-
public class Sight extends NamedModel<java.lang.Long>
-
-
Constructor Summary
Constructors Constructor Description Sight()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessLevel
getAccessLevel()
User's permissions on the Sight (OWNDER, ADMIN, VIEWER)java.lang.String
getBackgroundColor()
Get the background color of the Sightjava.lang.Integer
getColumnCount()
Get the number of columns that the Sight containsjava.util.Date
getCreatedAt()
Get time of Sight creationjava.lang.Boolean
getFavorite()
Get flag indicating whether the user has marked the Sight as a favoritejava.util.Date
getModifiedAt()
Get time of last modificationjava.lang.String
getPermalink()
URL that represents a direct link to the SightSource
getSource()
Gets the source.java.util.List<Widget>
getWidgets()
Get the array of Sight widgetsWorkspace
getWorkspace()
A workspace object limited to only id and nameSight
setAccessLevel(AccessLevel accessLevel)
Set User's permissions on the SightSight
setBackgroundColor(java.lang.String backgroundColor)
Set the background color of the SightSight
setColumnCount(java.lang.Integer columnCount)
Set the number of columns that the Sight containsSight
setCreatedAt(java.util.Date createdAt)
Set time of Sight creationSight
setFavorite(java.lang.Boolean favorite)
Set flag indicating whether the user has marked the Sight as a favoriteSight
setModifiedAt(java.util.Date modifiedAt)
Set time of last modificationSight
setName(java.lang.String name)
Provide an 'override' of setName (returns Sight not NamedModel)Sight
setPermalink(java.lang.String permalink)
Set URL pointing to a direct link to the SightSight
setSource(Source source)
Sets the source.Sight
setWidgets(java.util.List<Widget> widgets)
Set the array of Sight widgetsSight
setWorkspace(Workspace workspace)
Set workspace object for this Sight (limited to only id and name)-
Methods inherited from class com.smartsheet.api.models.NamedModel
getName
-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
setName
public Sight setName(java.lang.String name)
Provide an 'override' of setName (returns Sight not NamedModel)- Overrides:
setName
in classNamedModel<java.lang.Long>
- Parameters:
name
- the new name
-
getColumnCount
public java.lang.Integer getColumnCount()
Get the number of columns that the Sight contains- Returns:
- columnCount
-
setColumnCount
public Sight setColumnCount(java.lang.Integer columnCount)
Set the number of columns that the Sight contains
-
getWidgets
public java.util.List<Widget> getWidgets()
Get the array of Sight widgets- Returns:
- array of widgets
-
getFavorite
public java.lang.Boolean getFavorite()
Get flag indicating whether the user has marked the Sight as a favorite- Returns:
- favorite flag
-
setFavorite
public Sight setFavorite(java.lang.Boolean favorite)
Set flag indicating whether the user has marked the Sight as a favorite
-
getAccessLevel
public AccessLevel getAccessLevel()
User's permissions on the Sight (OWNDER, ADMIN, VIEWER)- Returns:
- accessLevel
-
setAccessLevel
public Sight setAccessLevel(AccessLevel accessLevel)
Set User's permissions on the Sight
-
getPermalink
public java.lang.String getPermalink()
URL that represents a direct link to the Sight- Returns:
- permalink
-
setPermalink
public Sight setPermalink(java.lang.String permalink)
Set URL pointing to a direct link to the Sight
-
getCreatedAt
public java.util.Date getCreatedAt()
Get time of Sight creation- Returns:
- createdAt (Date)
-
setCreatedAt
public Sight setCreatedAt(java.util.Date createdAt)
Set time of Sight creation
-
getModifiedAt
public java.util.Date getModifiedAt()
Get time of last modification- Returns:
- modifiedAt (Date)
-
setModifiedAt
public Sight setModifiedAt(java.util.Date modifiedAt)
Set time of last modification
-
getSource
public Source getSource()
Gets the source.- Returns:
- the source
-
getWorkspace
public Workspace getWorkspace()
A workspace object limited to only id and name- Returns:
- workspace
-
setWorkspace
public Sight setWorkspace(Workspace workspace)
Set workspace object for this Sight (limited to only id and name)
-
getBackgroundColor
public java.lang.String getBackgroundColor()
Get the background color of the Sight- Returns:
- the background color
-
setBackgroundColor
public Sight setBackgroundColor(java.lang.String backgroundColor)
Set the background color of the Sight- Parameters:
backgroundColor
- the background color
-
-