com.box.sdk

Enum BoxFile.Permission

Object

Enum<BoxFile.Permission>

BoxFile.Permission

All Implemented Interfaces:

Serializable, Comparable<BoxFile.Permission>

Enclosing class:

BoxFile

public static enum BoxFile.Permission
extends Enum<BoxFile.Permission>

Enumerates the possible permissions that a user can have on a file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAN_ANNOTATE The user can place annotations on this file.
CAN_COMMENT The user can comment on the file.
CAN_DELETE The user can delete the file.
CAN_DOWNLOAD The user can download the file.
CAN_INVITE_COLLABORATOR The current user can invite new users to collaborate on this item, and the user can update the role of a user already collaborated on this item.
CAN_PREVIEW The user can preview the file.
CAN_RENAME The user can rename the file.
CAN_SET_SHARE_ACCESS The user can set the access level for shared links to the file.
CAN_SHARE The user can share the file.
CAN_UPLOAD The user can upload new versions of the file.
CAN_VIEW_ANNOTATIONS_ALL The user can view all annotations placed on this file.
CAN_VIEW_ANNOTATIONS_SELF The user can view annotations placed by themselves on this file.

Method Summary

Modifier and Type	Method and Description
static BoxFile.Permission	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxFile.Permission[]	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

CAN_DOWNLOAD

public static final BoxFile.Permission CAN_DOWNLOAD

The user can download the file.

CAN_UPLOAD

public static final BoxFile.Permission CAN_UPLOAD

The user can upload new versions of the file.

CAN_RENAME

public static final BoxFile.Permission CAN_RENAME

The user can rename the file.

CAN_DELETE

public static final BoxFile.Permission CAN_DELETE

The user can delete the file.

CAN_SHARE

public static final BoxFile.Permission CAN_SHARE

The user can share the file.

CAN_SET_SHARE_ACCESS

public static final BoxFile.Permission CAN_SET_SHARE_ACCESS

The user can set the access level for shared links to the file.

CAN_PREVIEW

public static final BoxFile.Permission CAN_PREVIEW

The user can preview the file.

CAN_COMMENT

public static final BoxFile.Permission CAN_COMMENT

The user can comment on the file.

CAN_ANNOTATE

public static final BoxFile.Permission CAN_ANNOTATE

The user can place annotations on this file.

CAN_INVITE_COLLABORATOR

public static final BoxFile.Permission CAN_INVITE_COLLABORATOR

The current user can invite new users to collaborate on this item, and the user can update the role of a user already collaborated on this item.

CAN_VIEW_ANNOTATIONS_ALL

public static final BoxFile.Permission CAN_VIEW_ANNOTATIONS_ALL

The user can view all annotations placed on this file.

CAN_VIEW_ANNOTATIONS_SELF

public static final BoxFile.Permission CAN_VIEW_ANNOTATIONS_SELF

The user can view annotations placed by themselves on this file.

Method Detail

values

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

Returns:

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

valueOf

public static BoxFile.Permission 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