Package com.smartsheet.api.models

Class Favorite

  • public class Favorite
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Favorite.AddFavoriteBuilder
      A convenience class for making a Favorite object with the appropriate fields for adding to a Favorite.

    • Constructor Summary

      Constructors 
      Constructor Description
      Favorite()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Long getObjectId()
      Gets the ID of the favorited item.
      FavoriteType getType()
      Gets the type of favorite (workspace, folder, sheet, report, template).
      Favorite setObjectId​(java.lang.Long objectId)
      Sets the ID of the favorited item.
      Favorite setType​(FavoriteType type)
      Sets the type of favorite (workspace, folder, sheet, report, template).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Favorite

        public Favorite()

    • Method Detail

      • getObjectId

        public java.lang.Long getObjectId()
        Gets the ID of the favorited item.
        Returns:
        the objectId

      • setObjectId

        public Favorite setObjectId​(java.lang.Long objectId)
        Sets the ID of the favorited item.
        Parameters:
        objectId - ID of the favorited item.

      • getType

        public FavoriteType getType()
        Gets the type of favorite (workspace, folder, sheet, report, template).
        Returns:
        the type

      • setType

        public Favorite setType​(FavoriteType type)
        Sets the type of favorite (workspace, folder, sheet, report, template).
        Parameters:
        type - the new dependencies enabled