com.box.androidsdk.content.models

Class BoxEvent

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxEnterpriseEvent

public class BoxEvent
extends BoxEntity

Class that represents an event fired off by the Box events API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxEvent.Type Enumerates the possible known types for an event.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_CREATED_AT
static java.lang.String	FIELD_CREATED_BY
static java.lang.String	FIELD_EVENT_ID
static java.lang.String	FIELD_EVENT_TYPE
static java.lang.String	FIELD_IS_PACKAGE
static java.lang.String	FIELD_RECORDED_AT
static java.lang.String	FIELD_SESSION_ID
static java.lang.String	FIELD_SOURCE
static java.lang.String	FIELD_TYPE
static java.lang.String	TYPE

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

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE

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

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxEvent() Constructs an empty BoxEvent object.
BoxEvent(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxEvent with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
BoxCollaborator	getCreatedBy() The user that performed the action.
java.lang.String	getEventId() The id of the event, used for de-duplication purposes.
java.lang.String	getEventType() An event type from either a user event or enterprise event.
java.lang.Boolean	getIsPackage() Gets whether or not the file is an OSX package.
java.lang.String	getSessionId() The session of the user that performed the action
BoxEntity	getSource() The object that was modified.
java.lang.String	getType() The event type, 'event'
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

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

createEntityFromJson, createEntityFromJson, getId

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

createFromJson, createFromJson, getPropertiesAsHashMap, parseJsonObject, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_EVENT_ID

public static final java.lang.String FIELD_EVENT_ID

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final java.lang.String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_EVENT_TYPE

public static final java.lang.String FIELD_EVENT_TYPE

See Also:

Constant Field Values

FIELD_SESSION_ID

public static final java.lang.String FIELD_SESSION_ID

See Also:

Constant Field Values

FIELD_IS_PACKAGE

public static final java.lang.String FIELD_IS_PACKAGE

See Also:

Constant Field Values

FIELD_SOURCE

public static final java.lang.String FIELD_SOURCE

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final java.lang.String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_RECORDED_AT

public static final java.lang.String FIELD_RECORDED_AT

See Also:

Constant Field Values

Constructor Detail

BoxEvent

public BoxEvent()

Constructs an empty BoxEvent object.

BoxEvent

public BoxEvent(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxEvent with the provided map values.

Parameters:

map - map of keys and values of the object.

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 BoxEntity

Parameters:

member - the JSON member to be parsed.

getType

public java.lang.String getType()

The event type, 'event'

Overrides:

getType in class BoxEntity

Returns:

The event type, 'event'

getEventId

public java.lang.String getEventId()

The id of the event, used for de-duplication purposes.

Returns:

The id of the event, used for de-duplication purposes.

getCreatedBy

public BoxCollaborator getCreatedBy()

The user that performed the action.

Returns:

The user that performed the action.

getEventType

public java.lang.String getEventType()

An event type from either a user event or enterprise event.

Returns:

An event type from either a user event or enterprise event.

getSessionId

public java.lang.String getSessionId()

The session of the user that performed the action

Returns:

true if the file is an OSX package; otherwise false.

getIsPackage

public java.lang.Boolean getIsPackage()

Gets whether or not the file is an OSX package.

Returns:

true if the file is an OSX package; otherwise false.

getSource

public BoxEntity getSource()

The object that was modified. See Object definitions for appropriate object: file, folder, comment, etc. Not all events have a source object.

Returns:

The object that was modified.