com.box.boxjavalibv2.resourcemanagers

Class BoxEventsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxEventsManagerImpl

All Implemented Interfaces:

IBoxEventsManager, IBoxResourceManager

public class BoxEventsManagerImpl
extends AbstractBoxResourceManager
implements IBoxEventsManager

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
BoxEventsManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxCollection	getEventOptions(BoxDefaultRequestObject requestObject) Get Events options.
static List<BoxEvent>	getEvents(BoxCollection collection) Deprecated.
BoxEventCollection	getEvents(BoxEventRequestObject requestObject) Get Events.

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

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

BoxEventsManagerImpl

public BoxEventsManagerImpl(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

getEvents

public BoxEventCollection getEvents(BoxEventRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Description copied from interface: IBoxEventsManager

Get Events.

Specified by:

getEvents in interface IBoxEventsManager

Returns:

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getEventOptions

public BoxCollection getEventOptions(BoxDefaultRequestObject requestObject)
                              throws BoxRestException,
                                     BoxServerException,
                                     AuthFatalFailureException

Description copied from interface: IBoxEventsManager

Get Events options.

Specified by:

getEventOptions in interface IBoxEventsManager

Returns:

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getEvents

@Deprecated
public static List<BoxEvent> getEvents(BoxCollection collection)

Deprecated.

Get events from a collection. Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

comments