BoxResourceType (Nuxeo ECM Projects 7.10 API)

java.lang.Object
- java.lang.Enum<BoxResourceType>
- - org.nuxeo.box.api.marshalling.dao.BoxResourceType

All Implemented Interfaces:

Serializable, Comparable<BoxResourceType>, IBoxType
```
public enum BoxResourceType
extends Enum<BoxResourceType>
implements IBoxType
```
Type of resources that can be requested by API's.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIN_SETTINGS` Administrator settings
`COLLABORATION` Box's equivalent of access control lists.
`COLLABORATIONS` A plural format of `.BoxResourceType .COLLABORATIONS`.
`COMMENT` A comment.
`COMMENTS` A plural format of `COMMENT`.
`EMAIL_ALIAS` An email alias.
`EMAIL_ALIASES` A plural format of `EMAIL_ALIAS`.
`ERROR` Error.
`EVENT` Event.
`EVENTS` A plural format of `EVENT`.
`FILE` A box file.
`FILE_VERSION` A version of a file.
`FILE_VERSIONS` A plural format of `FILE_VERSION`.
`FILES` A plural format of `FILE`.
`FOLDER` A box folder.
`GROUP` A group of `GROUP`.
`ITEM` An item, which could be a file, a folder, a weblink...
`ITEMS` A plural format of `ITEM`.
`LOCK` File lock (shows up in event stream).
`LOGIN_TOKEN` Login token
`OAUTH_DATA` OAuth data.
`PREVIEW` Preview of a file.
`REALTIME_SERVER` Realtime server.
`SERVICE_ACTION` Service action is a subtype of file lock.
`UPDATES` Updates
`USER` A box user.
`USERS` A plural format of `USER`.
`WEB_LINK` A box weblink.
`WEB_LINKS` A plural format of `WEB_LINK`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static BoxResourceType`	`getTypeFromLowercaseString(String string)` Deprecated.
`String`	`toPluralString()` Get the String representing plural format of a resource.
`String`	`toString()`
`static BoxResourceType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BoxResourceType[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.box.api.marshalling.interfaces.IBoxType
name

- Enum Constant Detail
  - ITEM
```
public static final BoxResourceType ITEM
```
    An item, which could be a file, a folder, a weblink...
  - ITEMS
```
public static final BoxResourceType ITEMS
```
    A plural format of ITEM.
  - FILE
```
public static final BoxResourceType FILE
```
    A box file.
  - FILES
```
public static final BoxResourceType FILES
```
    A plural format of FILE.
  - WEB_LINK
```
public static final BoxResourceType WEB_LINK
```
    A box weblink.
  - WEB_LINKS
```
public static final BoxResourceType WEB_LINKS
```
    A plural format of WEB_LINK.
  - PREVIEW
```
public static final BoxResourceType PREVIEW
```
    Preview of a file.
  - FOLDER
```
public static final BoxResourceType FOLDER
```
    A box folder.
  - USER
```
public static final BoxResourceType USER
```
    A box user.
  - USERS
```
public static final BoxResourceType USERS
```
    A plural format of USER.
  - GROUP
```
public static final BoxResourceType GROUP
```
    A group of GROUP.
  - COMMENT
```
public static final BoxResourceType COMMENT
```
    A comment.
  - COMMENTS
```
public static final BoxResourceType COMMENTS
```
    A plural format of COMMENT.
  - FILE_VERSION
```
public static final BoxResourceType FILE_VERSION
```
    A version of a file.
  - FILE_VERSIONS
```
public static final BoxResourceType FILE_VERSIONS
```
    A plural format of FILE_VERSION.
  - COLLABORATION
```
public static final BoxResourceType COLLABORATION
```
    Box's equivalent of access control lists. They can be used to set and apply permissions for users to folders.
  - COLLABORATIONS
```
public static final BoxResourceType COLLABORATIONS
```
    A plural format of .BoxResourceType .COLLABORATIONS.
  - EMAIL_ALIAS
```
public static final BoxResourceType EMAIL_ALIAS
```
    An email alias.
  - EMAIL_ALIASES
```
public static final BoxResourceType EMAIL_ALIASES
```
    A plural format of EMAIL_ALIAS.
  - OAUTH_DATA
```
public static final BoxResourceType OAUTH_DATA
```
    OAuth data.
  - ERROR
```
public static final BoxResourceType ERROR
```
    Error.
  - EVENT
```
public static final BoxResourceType EVENT
```
    Event.
  - EVENTS
```
public static final BoxResourceType EVENTS
```
    A plural format of EVENT.
  - UPDATES
```
public static final BoxResourceType UPDATES
```
    Updates
  - REALTIME_SERVER
```
public static final BoxResourceType REALTIME_SERVER
```
    Realtime server.
  - LOCK
```
public static final BoxResourceType LOCK
```
    File lock (shows up in event stream).
  - SERVICE_ACTION
```
public static final BoxResourceType SERVICE_ACTION
```
    Service action is a subtype of file lock.
  - ADMIN_SETTINGS
```
public static final BoxResourceType ADMIN_SETTINGS
```
    Administrator settings
  - LOGIN_TOKEN
```
public static final BoxResourceType LOGIN_TOKEN
```
    Login token
- Method Detail
  - values
```
public static BoxResourceType[] 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 (BoxResourceType c : BoxResourceType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BoxResourceType 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
  - getTypeFromLowercaseString
```
@Deprecated
public static BoxResourceType getTypeFromLowercaseString(String string)
```
    Deprecated.
    
    Get the BoxResourceType from a lower case string value. For example "file" would return BoxResourceType.FILE Deprecated, use getTypeFromLowercaseString method in IBoxResourceHub instead.
    
    Parameters:
    
    string -
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<BoxResourceType>
  - toPluralString
```
public String toPluralString()
```
    Get the String representing plural format of a resource.
    
    Returns:
    
    the String representing plural format of a resource

Enum BoxResourceType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.box.api.marshalling.interfaces.IBoxType

Enum Constant Detail

ITEM

ITEMS

FILE

FILES

WEB_LINK

WEB_LINKS

PREVIEW

FOLDER

USER

USERS

GROUP

COMMENT

COMMENTS

FILE_VERSION

FILE_VERSIONS

COLLABORATION

COLLABORATIONS

EMAIL_ALIAS

EMAIL_ALIASES

OAUTH_DATA

ERROR

EVENT

EVENTS

UPDATES

REALTIME_SERVER

LOCK

SERVICE_ACTION

ADMIN_SETTINGS

LOGIN_TOKEN

Method Detail

values

valueOf

getTypeFromLowercaseString

toString

toPluralString