com.box.androidsdk.content.requests

Class BoxRequestsEvent.GetUserEvents

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestsEvent.GetUserEvents

Enclosing class:

BoxRequestsEvent

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

Request for retrieving a stream of user events.

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_LIMIT
static java.lang.String	FIELD_STREAM_POSITION
static java.lang.String	FIELD_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, mSession

Constructor Summary

Constructors

Constructor and Description
BoxRequestsEvent.GetUserEvents(java.lang.String requestUrl, BoxSession session) Creates a user event stream request with the default parameters.

Method Summary

Methods

Modifier and Type	Method and Description
E	send() Synchronously make the request to Box and handle the response appropriately.
R	setFilterDuplicates(boolean filterDuplicates) Sets whether or not the list of events contains duplicates which can be returned due to syncing issues.
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.
BoxRequestsEvent.GetUserEvents	setStreamType(java.lang.String streamType) Sets the stream type to limit the type of events in the response.

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

buildUrl, createHttpRequest, createQuery, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logDebug, logRequest, parseHashMapEntry, parseJsonObject, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

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

BoxRequestsEvent.GetUserEvents

public BoxRequestsEvent.GetUserEvents(java.lang.String requestUrl,
                              BoxSession session)

Creates a user event stream request 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

setStreamType

public BoxRequestsEvent.GetUserEvents setStreamType(java.lang.String streamType)

Sets the stream type to limit the type of events in the response.

Parameters:

streamType - type of events to return. Can be "all", "changes", or "sync".

Returns:

request with the updated stream type.

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

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

setFilterDuplicates

public R setFilterDuplicates(boolean filterDuplicates)

Sets whether or not the list of events contains duplicates which can be returned due to syncing issues. By default this is true.

Parameters:

filterDuplicates - true to do duplicate removal, false to allow returned list to contain the duplicates.

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.

send

public E send()
                             throws BoxException

Description copied from class: BoxRequest

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

Overrides:

send 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.