com.box.boxjavalibv2.requests.requestobjects

Class BoxEventRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxItemRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxEventRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxEventRequestObject
extends BoxItemRequestObject

Field Summary

Fields

Modifier and Type	Field and Description
static int	STREAM_POSITION_NOW Stream position of "now",See http://developers.box.com/docs/#events.
static String	STREAM_TYPE_ALL
static String	STREAM_TYPE_CHANGES
static String	STREAM_TYPE_SYNC

Method Summary

Methods

Modifier and Type	Method and Description
static BoxEventRequestObject	getEventsRequestObject(long streamPosition) Construct a new events object for fetching the event stream.
BoxEventRequestObject	setLimit(int limit) Set the limit for the number of events that will be returned.
BoxEventRequestObject	setStreamType(String streamType) Set the stream_type.

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxItemRequestObject

createSharedLinkRequestObject, deleteSharedLinkRequestObject, setDescription, setIfMatch, setName, setParent, setSharedLink, setTags

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

addField, addFields, addHeader, addQueryParam, get, getEntity, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, put, setJSONParser, setPage

Methods inherited from class java.lang.Object

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

Field Detail

STREAM_POSITION_NOW

public static final int STREAM_POSITION_NOW

Stream position of "now",See http://developers.box.com/docs/#events. Currently it's only supported for regular events, not enterprise events(admin_logs).

See Also:

Constant Field Values

STREAM_TYPE_ALL

public static final String STREAM_TYPE_ALL

See Also:

Constant Field Values

STREAM_TYPE_CHANGES

public static final String STREAM_TYPE_CHANGES

See Also:

Constant Field Values

STREAM_TYPE_SYNC

public static final String STREAM_TYPE_SYNC

See Also:

Constant Field Values

Method Detail

getEventsRequestObject

public static BoxEventRequestObject getEventsRequestObject(long streamPosition)

Construct a new events object for fetching the event stream.

Parameters:

streamPosition - Stream position. See http://developers.box.com/docs/#events for how to set this. To set this to "now", use BoxEventRequestObject.STREAM_POSITION_NOW.Don't use STREAM_POSITION_NOW if you are requesting for enterprise events(admin_logs),STREAM_POSITION_NOW is only supported for regular events.

Returns:

BoxEventRequestObject.

setStreamType

public BoxEventRequestObject setStreamType(String streamType)

Set the stream_type.

Parameters:

streamType - Use STREAM_TYPE_ALL (default), STREAM_TYPE_CHANGES or STREAM_TYPE_SYNC.

Returns:

BoxEventRequestObject.

setLimit

public BoxEventRequestObject setLimit(int limit)

Set the limit for the number of events that will be returned.

Parameters:

limit - Default is 100.

Returns:

BoxEventRequestObject.