com.box.sdk

Enum BoxCollaboration.Role

Object

Enum<BoxCollaboration.Role>

BoxCollaboration.Role

All Implemented Interfaces:

Serializable, Comparable<BoxCollaboration.Role>

Enclosing class:

BoxCollaboration

public static enum BoxCollaboration.Role
extends Enum<BoxCollaboration.Role>

Enumerates the possible access levels that a collaborator can have.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CO_OWNER The co-owner role has all of the functional read/write access that an editor does.
EDITOR An Editor has full read/write access to a folder.
OWNER The owner role has all of the functional capabilities of a co-owner.
PREVIEWER The previewer role has limited read access to a folder.
PREVIEWER_UPLOADER The previewer-uploader role is a combination of previewer and uploader.
UPLOADER The uploader has limited write access to a folder.
VIEWER The viewer role has full read access to a folder.
VIEWER_UPLOADER The viewer-uploader role is a combination of viewer and uploader.

Method Summary

Modifier and Type	Method and Description
static BoxCollaboration.Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxCollaboration.Role[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EDITOR

public static final BoxCollaboration.Role EDITOR

An Editor has full read/write access to a folder. Once invited to a folder, they will be able to view, download, upload, edit, delete, copy, move, rename, generate shared links, make comments, assign tasks, create tags, and invite/remove collaborators. They will not be able to delete or move root level folders.

VIEWER

public static final BoxCollaboration.Role VIEWER

The viewer role has full read access to a folder. Once invited to a folder, they will be able to preview, download, make comments, and generate shared links. They will not be able to add tags, invite new collaborators, upload, edit, or delete items in the folder.

PREVIEWER

public static final BoxCollaboration.Role PREVIEWER

The previewer role has limited read access to a folder. They will only be able to preview the items in the folder using the integrated content viewer. They will not be able to share, upload, edit, or delete any content. This role is only available to enterprise accounts.

UPLOADER

public static final BoxCollaboration.Role UPLOADER

The uploader has limited write access to a folder. They will only be able to upload and see the names of the items in a folder. They will not able to download or view any content. This role is only available to enterprise accounts.

PREVIEWER_UPLOADER

public static final BoxCollaboration.Role PREVIEWER_UPLOADER

The previewer-uploader role is a combination of previewer and uploader. A user with this access level will be able to preview files using the integrated content viewer as well as upload items into the folder. They will not be able to download, edit, or share, items in the folder. This role is only available to enterprise accounts.

VIEWER_UPLOADER

public static final BoxCollaboration.Role VIEWER_UPLOADER

The viewer-uploader role is a combination of viewer and uploader. A viewer-uploader has full read access to a folder and limited write access. They are able to preview, download, add comments, generate shared links, and upload content to the folder. They will not be able to add tags, invite new collaborators, edit, or delete items in the folder. This role is only available to enterprise accounts.

CO_OWNER

public static final BoxCollaboration.Role CO_OWNER

The co-owner role has all of the functional read/write access that an editor does. This permission level has the added ability of being able to manage users in the folder. A co-owner can add new collaborators, change access levels of existing collaborators, and remove collaborators. However, they will not be able to manipulate the owner of the folder or transfer ownership to another user. This role is only available to enterprise accounts.

OWNER

public static final BoxCollaboration.Role OWNER

The owner role has all of the functional capabilities of a co-owner. However, they will be able to manipulate the owner of the folder or transfer ownership to another user. This role is only available to enterprise accounts.

Method Detail

values

public static BoxCollaboration.Role[] 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 (BoxCollaboration.Role c : BoxCollaboration.Role.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoxCollaboration.Role valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null