public class BoxEventRequestObject extends BoxItemRequestObject
Modifier and Type | Field and Description |
---|---|
static int |
STREAM_POSITION_NOW |
static java.lang.String |
STREAM_TYPE_ALL |
static java.lang.String |
STREAM_TYPE_CHANGES |
static java.lang.String |
STREAM_TYPE_SYNC |
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(java.lang.String streamType)
Set the stream_type.
|
createSharedLinkRequestObject, deleteSharedLinkRequestObject, setDescription, setIfMatch, setName, setParent, setSharedLink
addField, addFields, addHeader, addQueryParam, get, getEntity, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, setJSONParser, setPage
public static final int STREAM_POSITION_NOW
public static final java.lang.String STREAM_TYPE_ALL
public static final java.lang.String STREAM_TYPE_CHANGES
public static final java.lang.String STREAM_TYPE_SYNC
public static BoxEventRequestObject getEventsRequestObject(long streamPosition)
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.public BoxEventRequestObject setStreamType(java.lang.String streamType)
streamType
- Use STREAM_TYPE_ALL (default), STREAM_TYPE_CHANGES or STREAM_TYPE_SYNC.public BoxEventRequestObject setLimit(int limit)
limit
- Default is 100.