Package com.smartsheet.api.oauth

Enum AccessScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AccessScope>
    public enum AccessScope
extends java.lang.Enum<AccessScope>
    Represents the access scope. These are the scopes that are required to access an end user's smartsheet data and specifies the type of operations that are permitted.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AccessScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AccessScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ADMIN_SHEETS

        public static final AccessScope ADMIN_SHEETS
        Modify sheet structure, including column definition, publish state, etc

      • ADMIN_SIGHTS

        public static final AccessScope ADMIN_SIGHTS
        Modify dashboards structure.

      • ADMIN_USERS

        public static final AccessScope ADMIN_USERS
        Add and remove users from your smartsheet organization

      • ADMIN_WEBHOOKS

        public static final AccessScope ADMIN_WEBHOOKS
        Create and manage webhooks

      • ADMIN_WORKSPACES

        public static final AccessScope ADMIN_WORKSPACES
        Create and manage workspaces and folders, including sharing

      • CREATE_SHEETS

        public static final AccessScope CREATE_SHEETS
        Create new sheets

      • CREATE_SIGHTS

        public static final AccessScope CREATE_SIGHTS
        Create new Sights

      • DELETE_SHEETS

        public static final AccessScope DELETE_SHEETS
        Delete Sheets

      • DELETE_SIGHTS

        public static final AccessScope DELETE_SIGHTS
        Delete Sights

      • READ_CONTACTS

        public static final AccessScope READ_CONTACTS
        Retrieve contacts.

      • READ_SHEETS

        public static final AccessScope READ_SHEETS
        Read all sheet data, including comments, attachments and cell data

      • READ_SIGHTS

        public static final AccessScope READ_SIGHTS
        Read all Sight data

      • READ_USERS

        public static final AccessScope READ_USERS
        Retrieve users and groups for your Smartsheet organization

      • SHARE_SHEETS

        public static final AccessScope SHARE_SHEETS
        Share sheets, including sending sheets as attachments

      • SHARE_SIGHTS

        public static final AccessScope SHARE_SIGHTS
        Share Sights

      • WRITE_SHEETS

        public static final AccessScope WRITE_SHEETS
        Insert and modify sheet data, including comments, attachments and cell data

    • Method Detail

      • values

        public static AccessScope[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AccessScope c : AccessScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AccessScope valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null