BoxAPI (eXo Cloud Drive :: Connectors :: Box

java.lang.Object
- org.exoplatform.clouddrive.box.BoxAPI

```
public class BoxAPI
extends Object
```
New Box Content API that replaces the Box SDK v2. Code adopted from the BoxAPI worked with SDK v2.
Created by The eXo Platform SAS.

Version:

$Id: BoxContentAPI.java 00000 Aug 19, 2015 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BoxAPI.ChangesLink

Nested Classes
Modifier and Type	Class and Description
`static class`	`BoxAPI.ChangesLink`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BOX_APP_URL` URL of Box app.
`static String`	`BOX_EMBED_URL` URL patter for Embedded UI of Box file.
`static String`	`BOX_EMBED_URL_SSO`
`static Set<com.box.sdk.BoxEvent.Type>`	`BOX_EVENTS`
`static String`	`BOX_FILE_URL` URL prefix for Box files' UI.
`protected static String`	`BOX_FILES_PATH` Not official part of the path used in file services with Box API.
`static String`	`BOX_ITEM_STATE_ACTIVE` Box item_status for active items.
`static String`	`BOX_ITEM_STATE_DELETED` Box item_status for deleted items.
`static String`	`BOX_ITEM_STATE_TRASHED` Box item_status for trashed items.
`static String`	`BOX_NOTE_EXT` Extension for Box's webdoc files.
`static String`	`BOX_NOTE_MIMETYPE` Custom mimetype for Box's note files.
`static int`	`BOX_PAGE_SIZE` Pagination size used within Box API.
`static String`	`BOX_ROOT_ID` Id of root folder on Box.
`static String`	`BOX_TRASH_ID` Id of Trash folder on Box.
`static Pattern`	`BOX_URL_CUSTOM_PATTERN`
`static Pattern`	`BOX_URL_MAKE_CUSTOM_PATTERN`
`static String`	`BOX_WEBDOCUMENT_EXT` Extension for Box's webdoc files.
`static String`	`BOX_WEBDOCUMENT_MIMETYPE` Custom mimetype for Box's webdoc files.
`static String`	`FOLDER_TYPE` Box folder type.
`static String[]`	`ITEM_FIELDS` An array of all file/folder fields that will be requested when calling `ItemsIterator`.
`protected static org.exoplatform.services.log.Log`	`LOG`
`static long`	`STREAM_POSITION_NOW`
`static String[]`	`USER_FIELDS`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
protected static final org.exoplatform.services.log.Log LOG
```
  - BOX_PAGE_SIZE
```
public static final int BOX_PAGE_SIZE
```
    Pagination size used within Box API.
    
    See Also:
    Constant Field Values
  - BOX_ROOT_ID
```
public static final String BOX_ROOT_ID
```
    Id of root folder on Box.
    
    See Also:
    Constant Field Values
  - BOX_TRASH_ID
```
public static final String BOX_TRASH_ID
```
    Id of Trash folder on Box.
    
    See Also:
    Constant Field Values
  - BOX_ITEM_STATE_ACTIVE
```
public static final String BOX_ITEM_STATE_ACTIVE
```
    Box item_status for active items.
    
    See Also:
    Constant Field Values
  - BOX_ITEM_STATE_TRASHED
```
public static final String BOX_ITEM_STATE_TRASHED
```
    Box item_status for trashed items.
    
    See Also:
    Constant Field Values
  - BOX_ITEM_STATE_DELETED
```
public static final String BOX_ITEM_STATE_DELETED
```
    Box item_status for deleted items.
    
    See Also:
    Constant Field Values
  - BOX_APP_URL
```
public static final String BOX_APP_URL
```
    URL of Box app.
    
    See Also:
    Constant Field Values
  - BOX_FILES_PATH
```
protected static final String BOX_FILES_PATH
```
    Not official part of the path used in file services with Box API.
    
    See Also:
    Constant Field Values
  - BOX_FILE_URL
```
public static final String BOX_FILE_URL
```
    URL prefix for Box files' UI.
    
    See Also:
    Constant Field Values
  - BOX_WEBDOCUMENT_EXT
```
public static final String BOX_WEBDOCUMENT_EXT
```
    Extension for Box's webdoc files.
    
    See Also:
    Constant Field Values
  - BOX_WEBDOCUMENT_MIMETYPE
```
public static final String BOX_WEBDOCUMENT_MIMETYPE
```
    Custom mimetype for Box's webdoc files.
    
    See Also:
    Constant Field Values
  - BOX_NOTE_EXT
```
public static final String BOX_NOTE_EXT
```
    Extension for Box's webdoc files.
    
    See Also:
    Constant Field Values
  - BOX_NOTE_MIMETYPE
```
public static final String BOX_NOTE_MIMETYPE
```
    Custom mimetype for Box's note files.
    
    See Also:
    Constant Field Values
  - BOX_EMBED_URL
```
public static final String BOX_EMBED_URL
```
    URL patter for Embedded UI of Box file. Based on:
    http://stackoverflow.com/questions/12816239/box-com-embedded-file-folder-viewer-code-via-api http://developers.box.com/box-embed/
    
    See Also:
    Constant Field Values
  - BOX_EMBED_URL_SSO
```
public static final String BOX_EMBED_URL_SSO
```
    See Also:
    Constant Field Values
  - BOX_URL_CUSTOM_PATTERN
```
public static final Pattern BOX_URL_CUSTOM_PATTERN
```
  - BOX_URL_MAKE_CUSTOM_PATTERN
```
public static final Pattern BOX_URL_MAKE_CUSTOM_PATTERN
```
  - STREAM_POSITION_NOW
```
public static final long STREAM_POSITION_NOW
```
    See Also:
    Constant Field Values
  - FOLDER_TYPE
```
public static final String FOLDER_TYPE
```
    Box folder type.
    
    See Also:
    Constant Field Values
  - BOX_EVENTS
```
public static final Set<com.box.sdk.BoxEvent.Type> BOX_EVENTS
```
  - ITEM_FIELDS
```
public static final String[] ITEM_FIELDS
```
    An array of all file/folder fields that will be requested when calling ItemsIterator.
  - USER_FIELDS
```
public static final String[] USER_FIELDS
```

Class BoxAPI

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

BOX_PAGE_SIZE

BOX_ROOT_ID

BOX_TRASH_ID

BOX_ITEM_STATE_ACTIVE

BOX_ITEM_STATE_TRASHED

BOX_ITEM_STATE_DELETED

BOX_APP_URL

BOX_FILES_PATH

BOX_FILE_URL

BOX_WEBDOCUMENT_EXT

BOX_WEBDOCUMENT_MIMETYPE

BOX_NOTE_EXT

BOX_NOTE_MIMETYPE

BOX_EMBED_URL

BOX_EMBED_URL_SSO

BOX_URL_CUSTOM_PATTERN

BOX_URL_MAKE_CUSTOM_PATTERN

STREAM_POSITION_NOW

FOLDER_TYPE

BOX_EVENTS

ITEM_FIELDS

USER_FIELDS