com.box.sdk

Class BoxEvent

Object

BoxResource

BoxEvent

@BoxResourceType(value="event")
public class BoxEvent
extends BoxResource

Represents an event that was fired off by the Box events API.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class BoxResource

BoxResource.Info

Constructor Summary

Constructors

Constructor and Description
BoxEvent(BoxAPIConnection api, String json) Constructs a BoxEvent from a JSON string.

Method Summary

Modifier and Type	Method and Description
BoxCollaborator.Info	getAccessibleBy() Gets info about the collaborator who was given access to a folder within the current enterprise.
BoxUser.Info	getActionBy() Gets the user that performed the action for this event.
JsonObject	getAdditionalDetails() Gets a JSON object containing additional details about this event.
Date	getCreatedAt() Gets the time that this event was created.
BoxUser.Info	getCreatedBy() Gets info about the user that triggered this event.
BoxEvent.EventType	getEventType() Gets the type of this event.
String	getIPAddress() Gets the IP address of the user that triggered this event.
String	getSessionID() Gets the session ID of the user that triggered this event.
BoxResource.Info	getSourceInfo() Gets info about the source of this event.
JsonObject	getSourceJSON() Gets the raw JSON object containing information about the source of this event.
String	getTypeName() Gets the type name as String.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Constructor Detail

BoxEvent

public BoxEvent(BoxAPIConnection api,
                String json)

Constructs a BoxEvent from a JSON string.

Parameters:

api - the API connection to be used by the file.

json - the JSON encoded event.

Method Detail

getSourceInfo

public BoxResource.Info getSourceInfo()

Gets info about the source of this event.

Note that there is a bug in the enterprise event stream where certain event sources don't correctly map to a BoxResource.Info. In the case where the event source JSON cannot be mapped to a BoxResource.Info, you can use the getSourceJSON() method to access the raw JSON representation of the event source.

Returns:

info about the source of this event.

getSourceJSON

public JsonObject getSourceJSON()

Gets the raw JSON object containing information about the source of this event.

This method can be used to work around bugs in the enterprise events API where some enterprise event sources don't correctly map to a BoxResource.Info. In this case, this method can be used to access the raw JSON directly.

Returns:

the JSON representation of the source of this event.

getEventType

public BoxEvent.EventType getEventType()

Gets the type of this event.

Returns:

the type of this event.

getTypeName

public String getTypeName()

Gets the type name as String. Every BoxEvent will have typeName, some will have eventType set to specific value and some will have eventType = UNKNOWN.

Returns:

the name of the type of this event.

getCreatedAt

public Date getCreatedAt()

Gets the time that this event was created.

Returns:

the time that this event was created.

getIPAddress

public String getIPAddress()

Gets the IP address of the user that triggered this event.

Returns:

the IP address of the user that triggered this event.

getAdditionalDetails

public JsonObject getAdditionalDetails()

Gets a JSON object containing additional details about this event.

The fields and data within the returned JSON object will vary depending on the type of the event.

Returns:

a JSON object containing additional details about this event.

getAccessibleBy

public BoxCollaborator.Info getAccessibleBy()

Gets info about the collaborator who was given access to a folder within the current enterprise.

This field is only populated when the event is related to a collaboration that occurred within an enterprise.

Returns:

info about the collaborator who was given access to a folder within the current enterprise.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets info about the user that triggered this event.

Returns:

info about the user that triggered this event.

getSessionID

public String getSessionID()

Gets the session ID of the user that triggered this event.

Returns:

the session ID of the user that triggered this event.

getActionBy

public BoxUser.Info getActionBy()

Gets the user that performed the action for this event.

Returns:

info about the user that performed that action for this event.