public class

Event

extends Entity
java.lang.Object
   ↳ org.mule.modules.box.model.Entity
     ↳ org.mule.modules.box.model.Event

Class Overview

When something changes in a user’s Box account, either in folders they own or folders they collaborate on, Box logs an 'event' for the user. Box's /events endpoint is focused on delivering to you a low latency, highly reliable list of all the events relevant to your Box account. Events are registered against a time-sequenced list called the streamPosition. When you do a GET against /events API and pass in a streamPosition Box responds to you with the events that happened slightly before that stream position, up to the current streamPosition, or the chunkSize, whichever is lesser. Due to timing lag across Box's multiple datacenters, and our preference of low-latency and insurance to make sure you don’t miss some event, you may receive duplicate events when you call the /events API. You should use the eventId field in each returned event to check for duplicate events and discard ones that you have already processed. You may also receive events that are 'before' events that you’ve already received by roughly 5-15 seconds. This is simply due to the variability in when events get recorded, and Box's preference for delivering events to you as soon as they know about them.

Summary

Constants
long serialVersionUID
[Expand]
Inherited Constants
From class org.mule.modules.box.model.Entity
Fields
private String createdAt The time when the event was created
private User createdBy
private String eventId The id of the event, used for de-duplication purposes
private String eventType The type of event
private String recordedAt The time when the event was recorded
private String sessionId The session of the user that performed the action
private Entity source The object that was modified.
[Expand]
Inherited Fields
From class org.mule.modules.box.model.Entity
Public Constructors
Event()
Public Methods
String getCreatedAt()
User getCreatedBy()
String getEventId()
String getEventType()
String getRecordedAt()
String getSessionId()
Entity getSource()
void setCreatedAt(String createdAt)
void setCreatedBy(User createdBy)
void setEventId(String eventId)
void setEventType(String eventType)
void setRecordedAt(String recordedAt)
void setSessionId(String sessionId)
void setSource(Entity source)
[Expand]
Inherited Methods
From class org.mule.modules.box.model.Entity
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -6515021079291400859 (0xa595fed8b0a76d65)

Fields

private String createdAt

The time when the event was created

private User createdBy

private String eventId

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

private String eventType

The type of event

private String recordedAt

The time when the event was recorded

private String sessionId

The session of the user that performed the action

private Entity source

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

Public Constructors

public Event ()

Public Methods

public String getCreatedAt ()

public User getCreatedBy ()

public String getEventId ()

public String getEventType ()

public String getRecordedAt ()

public String getSessionId ()

public Entity getSource ()

public void setCreatedAt (String createdAt)

Parameters
createdAt

public void setCreatedBy (User createdBy)

Parameters
createdBy

public void setEventId (String eventId)

Parameters
eventId

public void setEventType (String eventType)

Parameters
eventType

public void setRecordedAt (String recordedAt)

Parameters
recordedAt

public void setSessionId (String sessionId)

Parameters
sessionId

public void setSource (Entity source)

Parameters
source