com.box.androidsdk.content.requests

Class BoxRequestsEvent.GetEnterpriseEvents

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestsEvent.GetEnterpriseEvents

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorEnterpriseEvents>, java.io.Serializable

Enclosing class:

BoxRequestsEvent

public static class BoxRequestsEvent.GetEnterpriseEvents
extends BoxRequest<E,R>

Request for retrieving a stream of all events in an enterprise.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_CREATED_AFTER
static java.lang.String	FIELD_CREATED_BEFORE
static java.lang.String	FIELD_LIMIT
static java.lang.String	FIELD_STREAM_POSITION
static java.lang.String	FIELD_STREAM_TYPE
protected static java.lang.String	STREAM_TYPE
static java.lang.String	STREAM_TYPE_ALL
static java.lang.String	STREAM_TYPE_CHANGES
static java.lang.String	STREAM_TYPE_SYNC

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
GetEnterpriseEvents(java.lang.String requestUrl, BoxSession session) Creates an enterprise event stream with the default parameters.

Method Summary

Modifier and Type	Method and Description
static BoxRequest.BoxRequestHandler<com.box.androidsdk.content.requests.BoxRequestEvent>	createRequestHandler(com.box.androidsdk.content.requests.BoxRequestEvent request)
E	onSend() Synchronously make the request to Box and handle the response appropriately.
protected void	onSendCompleted(BoxResponse<E> response) Post action that will be performed after a successful send occurs.
E	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsEvent.GetEnterpriseEvents	setCreatedAfter(java.util.Date date) Sets the lower bound on the timestamp of events returned in the request.
BoxRequestsEvent.GetEnterpriseEvents	setCreatedBefore(java.util.Date date) Sets the upper bound on the timestamp of events returned in the request.
R	setLimit(int limit) Sets the maximum number of events to return in the list of events.
R	setPreviousListEvents(E listEvents) Convenience method.
R	setStreamPosition(java.lang.String streamPosition) Sets the stream position of items that should be returned.
protected R	setStreamType(java.lang.String streamType) Limits the type of events returned.
BoxFutureTask<E>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_CREATED_AFTER

public static final java.lang.String FIELD_CREATED_AFTER

See Also:

Constant Field Values

FIELD_CREATED_BEFORE

public static final java.lang.String FIELD_CREATED_BEFORE

See Also:

Constant Field Values

STREAM_TYPE

protected static final java.lang.String STREAM_TYPE

See Also:

Constant Field Values

STREAM_TYPE_ALL

public static final java.lang.String STREAM_TYPE_ALL

See Also:

Constant Field Values

STREAM_TYPE_CHANGES

public static final java.lang.String STREAM_TYPE_CHANGES

See Also:

Constant Field Values

STREAM_TYPE_SYNC

public static final java.lang.String STREAM_TYPE_SYNC

See Also:

Constant Field Values

FIELD_STREAM_POSITION

public static final java.lang.String FIELD_STREAM_POSITION

See Also:

Constant Field Values

FIELD_STREAM_TYPE

public static final java.lang.String FIELD_STREAM_TYPE

See Also:

Constant Field Values

FIELD_LIMIT

public static final java.lang.String FIELD_LIMIT

See Also:

Constant Field Values

Constructor Detail

GetEnterpriseEvents

public GetEnterpriseEvents(java.lang.String requestUrl,
                           BoxSession session)

Creates an enterprise event stream with the default parameters.

Parameters:

requestUrl - URL for the events endpoint.

session - the authenticated session that will be used to make the request with.

Method Detail

setCreatedAfter

public BoxRequestsEvent.GetEnterpriseEvents setCreatedAfter(java.util.Date date)

Sets the lower bound on the timestamp of events returned in the request.

Parameters:

date - date events should be created after.

Returns:

request with the updated created after date.

setCreatedBefore

public BoxRequestsEvent.GetEnterpriseEvents setCreatedBefore(java.util.Date date)

Sets the upper bound on the timestamp of events returned in the request.

Parameters:

date - date events should be created before.

Returns:

request with the updated created before date.

createRequestHandler

public static BoxRequest.BoxRequestHandler<com.box.androidsdk.content.requests.BoxRequestEvent> createRequestHandler(com.box.androidsdk.content.requests.BoxRequestEvent request)

setStreamPosition

public R setStreamPosition(java.lang.String streamPosition)

Sets the stream position of items that should be returned. Usually a number in String format, but can be "now".

Parameters:

streamPosition - stream position to start from for returning events.

Returns:

the get events request

setStreamType

protected R setStreamType(java.lang.String streamType)

Limits the type of events returned. Can be set to: all: returns everything changes: returns tree changes sync: returns tree changes only for sync folders admin_logs: used for events in enterprise.

Parameters:

streamType - the type of events to get.

Returns:

the get events request

setLimit

public R setLimit(int limit)

Sets the maximum number of events to return in the list of events.

Parameters:

limit - max number of events to request.

Returns:

the get events request

setPreviousListEvents

public R setPreviousListEvents(E listEvents)

Convenience method. When set the request will be set to the next stream position from the given event and will will aggregate the new results with the provided list.

Parameters:

listEvents - A list of events to add to.

Returns:

A BoxRequestEvent object.

onSend

public E onSend()
         throws BoxException

Description copied from class: BoxRequest

Synchronously make the request to Box and handle the response appropriately.

Overrides:

onSend in class BoxRequest<E extends BoxJsonObject,R extends BoxRequest<E,R>>

Returns:

the expected BoxObject if the request is successful.

Throws:

BoxException - thrown if there was a problem with handling the request.

sendForCachedResult

public E sendForCachedResult()
                      throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<E extends BoxJsonObject>

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

public BoxFutureTask<E> toTaskForCachedResult()
                                       throws BoxException

Description copied from interface: BoxCacheableRequest

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Specified by:

toTaskForCachedResult in interface BoxCacheableRequest<E extends BoxJsonObject>

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.

onSendCompleted

protected void onSendCompleted(BoxResponse<E> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<E extends BoxJsonObject,R extends BoxRequest<E,R>>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.