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.

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxEntity

BoxEntity.BoxEntityCreator

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE
static java.lang.String	EVENT_TYPE_COLLAB_ADD_COLLABORATOR
static java.lang.String	EVENT_TYPE_COLLAB_INVITE_COLLABORATOR
static java.lang.String	EVENT_TYPE_COMMENT_CREATE
static java.lang.String	EVENT_TYPE_ITEM_COPY
static java.lang.String	EVENT_TYPE_ITEM_CREATE
static java.lang.String	EVENT_TYPE_ITEM_DOWNLOAD
static java.lang.String	EVENT_TYPE_ITEM_MOVE
static java.lang.String	EVENT_TYPE_ITEM_PREVIEW
static java.lang.String	EVENT_TYPE_ITEM_RENAME
static java.lang.String	EVENT_TYPE_ITEM_SHARED
static java.lang.String	EVENT_TYPE_ITEM_SHARED_CREATE
static java.lang.String	EVENT_TYPE_ITEM_SHARED_UNSHARE
static java.lang.String	EVENT_TYPE_ITEM_SYNC
static java.lang.String	EVENT_TYPE_ITEM_TRASH
static java.lang.String	EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH
static java.lang.String	EVENT_TYPE_ITEM_UNSYNC
static java.lang.String	EVENT_TYPE_ITEM_UPLOAD
static java.lang.String	EVENT_TYPE_LOCK_CREATE
static java.lang.String	EVENT_TYPE_LOCK_DESTROY
static java.lang.String	EVENT_TYPE_TAG_ITEM_CREATE
static java.lang.String	EVENT_TYPE_TASK_ASSIGNMENT_CREATE
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

Constructor Summary

Constructors

Constructor and Description
BoxEvent() Constructs an empty BoxEvent object.
BoxEvent(com.eclipsesource.json.JsonObject jsonObject) Constructs a BoxEvent with the provided JsonObject.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getCreatedAt() The time the user performed the action
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.util.Date	getRecordedAt() The time the action was recorded at
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'

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

addEntityType, createEntityFromJson, createEntityFromJson, getBoxJsonObjectCreator, getId

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

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

EVENT_TYPE_ITEM_CREATE

public static final java.lang.String EVENT_TYPE_ITEM_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UPLOAD

public static final java.lang.String EVENT_TYPE_ITEM_UPLOAD

See Also:

Constant Field Values

EVENT_TYPE_COMMENT_CREATE

public static final java.lang.String EVENT_TYPE_COMMENT_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_DOWNLOAD

public static final java.lang.String EVENT_TYPE_ITEM_DOWNLOAD

See Also:

Constant Field Values

EVENT_TYPE_ITEM_PREVIEW

public static final java.lang.String EVENT_TYPE_ITEM_PREVIEW

See Also:

Constant Field Values

EVENT_TYPE_ITEM_MOVE

public static final java.lang.String EVENT_TYPE_ITEM_MOVE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_COPY

public static final java.lang.String EVENT_TYPE_ITEM_COPY

See Also:

Constant Field Values

EVENT_TYPE_TASK_ASSIGNMENT_CREATE

public static final java.lang.String EVENT_TYPE_TASK_ASSIGNMENT_CREATE

See Also:

Constant Field Values

EVENT_TYPE_LOCK_CREATE

public static final java.lang.String EVENT_TYPE_LOCK_CREATE

See Also:

Constant Field Values

EVENT_TYPE_LOCK_DESTROY

public static final java.lang.String EVENT_TYPE_LOCK_DESTROY

See Also:

Constant Field Values

EVENT_TYPE_ITEM_TRASH

public static final java.lang.String EVENT_TYPE_ITEM_TRASH

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH

public static final java.lang.String EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH

See Also:

Constant Field Values

EVENT_TYPE_COLLAB_ADD_COLLABORATOR

public static final java.lang.String EVENT_TYPE_COLLAB_ADD_COLLABORATOR

See Also:

Constant Field Values

EVENT_TYPE_COLLAB_INVITE_COLLABORATOR

public static final java.lang.String EVENT_TYPE_COLLAB_INVITE_COLLABORATOR

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SYNC

public static final java.lang.String EVENT_TYPE_ITEM_SYNC

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UNSYNC

public static final java.lang.String EVENT_TYPE_ITEM_UNSYNC

See Also:

Constant Field Values

EVENT_TYPE_ITEM_RENAME

public static final java.lang.String EVENT_TYPE_ITEM_RENAME

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED_CREATE

public static final java.lang.String EVENT_TYPE_ITEM_SHARED_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED_UNSHARE

public static final java.lang.String EVENT_TYPE_ITEM_SHARED_UNSHARE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED

public static final java.lang.String EVENT_TYPE_ITEM_SHARED

See Also:

Constant Field Values

EVENT_TYPE_TAG_ITEM_CREATE

public static final java.lang.String EVENT_TYPE_TAG_ITEM_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE

public static final java.lang.String EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE

See Also:

Constant Field Values

Constructor Detail

BoxEvent

public BoxEvent()

Constructs an empty BoxEvent object.

BoxEvent

public BoxEvent(com.eclipsesource.json.JsonObject jsonObject)

Constructs a BoxEvent with the provided JsonObject.

Parameters:

jsonObject - jsonObject to use to create an instance of this class.

Method Detail

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.

getCreatedAt

public java.util.Date getCreatedAt()

The time the user performed the action

Returns:

Time user performed the action.

getRecordedAt

public java.util.Date getRecordedAt()

The time the action was recorded at

Returns:

Time action was recorded

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.