com.box.androidsdk.content.models

Class BoxListEvents

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxList<BoxEvent>

com.box.androidsdk.content.models.BoxListEvents

All Implemented Interfaces:

IStreamPosition, java.io.Serializable, java.lang.Iterable<BoxEvent>, java.util.Collection<BoxEvent>

public class BoxListEvents
extends BoxList<BoxEvent>
implements IStreamPosition

Class representing a list of events fired off by the Box events API.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_CHUNK_SIZE
static java.lang.String	FIELD_NEXT_STREAM_POSITION

Fields inherited from class com.box.androidsdk.content.models.BoxList

collection, collectionInProperties, FIELD_ENTRIES, FIELD_LIMIT, FIELD_OFFSET, FIELD_ORDER, FIELD_TOTAL_COUNT

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxListEvents()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(BoxEvent boxEvent)
boolean	addAll(java.util.Collection<? extends BoxEvent> c)
void	clear()
java.lang.Long	getChunkSize() Gets the number of event records returned in this chunk.
java.lang.Long	getNextStreamPosition() Gets the next position in the event stream that you should request in order to get the next events.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
void	setFilterDuplicates(boolean filterDuplicates) Sets whether or not to filter out duplicate events which can occur due to syncing issues.

Methods inherited from class com.box.androidsdk.content.models.BoxList

addCollectionToProperties, contains, containsAll, equals, fullSize, get, getSortOrders, hashCode, isEmpty, iterator, limit, offset, parseJsonObject, retainAll, size, toArray, toArray

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

createFromJson, createFromJson, getPropertiesAsHashMap, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_CHUNK_SIZE

public static final java.lang.String FIELD_CHUNK_SIZE

See Also:

Constant Field Values

FIELD_NEXT_STREAM_POSITION

public static final java.lang.String FIELD_NEXT_STREAM_POSITION

See Also:

Constant Field Values

Constructor Detail

BoxListEvents

public BoxListEvents()

Method Detail

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxList<BoxEvent>

Parameters:

member - the JSON member to be parsed.

add

public boolean add(BoxEvent boxEvent)

Specified by:

add in interface java.util.Collection<BoxEvent>

Overrides:

add in class BoxList<BoxEvent>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<BoxEvent>

Overrides:

remove in class BoxList<BoxEvent>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<BoxEvent>

Overrides:

removeAll in class BoxList<BoxEvent>

addAll

public boolean addAll(java.util.Collection<? extends BoxEvent> c)

Specified by:

addAll in interface java.util.Collection<BoxEvent>

Overrides:

addAll in class BoxList<BoxEvent>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<BoxEvent>

Overrides:

clear in class BoxList<BoxEvent>

getChunkSize

public java.lang.Long getChunkSize()

Gets the number of event records returned in this chunk.

Returns:

number of event records returned.

getNextStreamPosition

public java.lang.Long getNextStreamPosition()

Gets the next position in the event stream that you should request in order to get the next events.

Specified by:

getNextStreamPosition in interface IStreamPosition

Returns:

next position in the event stream to request in order to get the next events.

setFilterDuplicates

public void setFilterDuplicates(boolean filterDuplicates)

Sets whether or not to filter out duplicate events which can occur due to syncing issues.

Parameters:

filterDuplicates - whether or not to filter out duplicate events.