com.box.androidsdk.content

Class BoxApiEvent

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiEvent

public class BoxApiEvent
extends BoxApi

Represents the API of the event endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENTS_ENDPOINT

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiEvent(BoxSession session) Constructs a BoxApiEvent with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsEvent.GetEnterpriseEvents	getEnterpriseEventsRequest() Gets a request that retrieves enterprise events
protected java.lang.String	getEventsUrl()
RealTimeServerConnection	getLongPollServerConnection(RealTimeServerConnection.OnChangeListener changeListener) Gets a request that retrieves a RealTimeServerConnection, which is used to create a long poll to check for some generic change to the user's account.
BoxRequestsEvent.GetUserEvents	getUserEventsRequest() Gets a request that retrieves user events

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Field Detail

EVENTS_ENDPOINT

public static final java.lang.String EVENTS_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

BoxApiEvent

public BoxApiEvent(BoxSession session)

Constructs a BoxApiEvent with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiEvent

Method Detail

getEventsUrl

protected java.lang.String getEventsUrl()

getUserEventsRequest

public BoxRequestsEvent.GetUserEvents getUserEventsRequest()

Gets a request that retrieves user events

Returns:

request to get user events

getEnterpriseEventsRequest

public BoxRequestsEvent.GetEnterpriseEvents getEnterpriseEventsRequest()

Gets a request that retrieves enterprise events

Returns:

request to retrieve enterprise events

getLongPollServerConnection

public RealTimeServerConnection getLongPollServerConnection(RealTimeServerConnection.OnChangeListener changeListener)

Gets a request that retrieves a RealTimeServerConnection, which is used to create a long poll to check for some generic change to the user's account. This can be combined with syncing logic using getUserEventsRequest or getEnterpriseEventsRequest to discover what has changed.

Parameters:

changeListener - A listener that will get triggered when a change has been made to the user's account or an exception has occurred.

Returns:

A RealTimeServerConnection that checks for a change to a user's account.