com.box.boxjavalibv2.resourcemanagers

Class BoxEventsManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxEventsManager

public class BoxEventsManager
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
BoxEventsManager(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) Get comments from a collection.
BoxEventCollection	getEvents(BoxEventRequestObject requestObject) Get Events.

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

BoxEventsManager

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

Get Events.

Parameters:

stream_position -

stream_type -

limit -

requestObject -

Returns:

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

getEventOptions

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

Get Events options.

Parameters:

requestObject -

Returns:

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

getEvents

public static List<BoxEvent> getEvents(BoxCollection collection)

Get comments from a collection.

Parameters:

collection - collection

Returns:

comments