Package com.smartsheet.api.models

Class Sight

  • public class Sight
extends NamedModel<java.lang.Long>

    • Constructor Detail

      • Sight

        public Sight()

    • Method Detail

      • setName

        public Sight setName​(java.lang.String name)
        Provide an 'override' of setName (returns Sight not NamedModel)
        Overrides:
        setName in class NamedModel<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

      • setWidgets

        public Sight setWidgets​(java.util.List<Widget> widgets)
        Set the array of Sight widgets

      • 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.
        Get flag indicating whether the user has marked the Sight as a favorite
        Returns:
        favorite flag

      • setFavorite

        @Deprecated(since="3.2.2",
            forRemoval=true)
public Sight 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.
        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

      • setSource

        public Sight setSource​(Source source)
        Sets the source.
        Parameters:
        source - 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