com.box.sdk

Class BoxEvent

Object

BoxResource

BoxEvent

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.Type 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

Methods

Modifier and Type	Method and Description
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.
BoxEvent.Type	getType() Gets the type of this event.

Methods inherited from class BoxResource

equals, getAPI, getID, 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.

getType

public BoxEvent.Type getType()

Gets the type of this event.

Returns:

the type of this event.