com.box.boxjavalibv2.resourcemanagers

Class BoxItemsManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManager

Direct Known Subclasses:

BoxFilesManager, BoxFoldersManager, BoxSearchManager

public class BoxItemsManager
extends BoxResourceManager

Use this class to execute requests synchronously against the Box REST API(V2). Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

Constructor and Description
BoxItemsManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxItem	copyItem(String id, BoxItemRequestObject requestObject, BoxResourceType type) Copy an item.
BoxItem	createSharedLink(String id, BoxItemRequestObject requestObject, BoxResourceType type) Create a shared link for an item, given the id .
void	deleteTrashItem(String id, BoxResourceType type, BoxFileRequestObject requestObject) Permanently delete a trashed item.
BoxItem	getItem(String id, BoxDefaultRequestObject requestObject, BoxResourceType type) Get item given an item id.
BoxItem	getTrashItem(String itemId, BoxResourceType type, BoxDefaultRequestObject requestObject) Get a trashed item.
BoxItem	restoreTrashItem(String id, BoxResourceType type, BoxItemRestoreRequestObject requestObject) Restore a trashed item.
BoxItem	updateItemInfo(String id, BoxItemRequestObject requestObject, BoxResourceType type) Update info for an item

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxItemsManager

public BoxItemsManager(IBoxConfig config,
               IBoxResourceHub resourceHub,
               IBoxJSONParser parser,
               IBoxRequestAuth auth,
               IBoxRESTClient restClient)

Constructor.

Parameters:

config - BoxConfig

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getItem

public BoxItem getItem(String id,
              BoxDefaultRequestObject requestObject,
              BoxResourceType type)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Get item given an item id.

Parameters:

id - id of the item

BoxBasicRequestObject - requestObject

type - resource type

Returns:

requested box file/folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getTrashItem

public BoxItem getTrashItem(String itemId,
                   BoxResourceType type,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Get a trashed item.

Parameters:

itemId - item id

type - type

requestObject - request object

Returns:

the item

Throws:

BoxRestException - exception

AuthFatalFailureException - exception

BoxServerException - exception

copyItem

public BoxItem copyItem(String id,
               BoxItemRequestObject requestObject,
               BoxResourceType type)
                 throws BoxRestException,
                        BoxServerException,
                        AuthFatalFailureException

Copy an item.

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

copied file/folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

updateItemInfo

public BoxItem updateItemInfo(String id,
                     BoxItemRequestObject requestObject,
                     BoxResourceType type)
                       throws UnsupportedEncodingException,
                              BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Update info for an item

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

updated file/folder

Throws:

UnsupportedEncodingException - exception

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

createSharedLink

public BoxItem createSharedLink(String id,
                       BoxItemRequestObject requestObject,
                       BoxResourceType type)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Create a shared link for an item, given the id .

Parameters:

auth - authorization

id - id of the item

requestObject - request object

type - resource type of this item

Returns:

the file/folder, with shared link related fields filled in.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteTrashItem

public void deleteTrashItem(String id,
                   BoxResourceType type,
                   BoxFileRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Permanently delete a trashed item.

Parameters:

id - id of the item

type - resource type of the item.

requestObject - request object

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

restoreTrashItem

public BoxItem restoreTrashItem(String id,
                       BoxResourceType type,
                       BoxItemRestoreRequestObject requestObject)
                         throws BoxRestException,
                                AuthFatalFailureException,
                                BoxServerException

Restore a trashed item.

Parameters:

id - id of the trashed item.

type - type of the item

requestObject -

Returns:

the item.

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException