com.box.androidsdk.content.requests

Class BoxRequestsEvent.LongPollMessageRequest

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxSimpleMessage,BoxRequestsEvent.LongPollMessageRequest>

com.box.androidsdk.content.requests.BoxRequestsEvent.LongPollMessageRequest

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsEvent

public static class BoxRequestsEvent.LongPollMessageRequest
extends BoxRequest<BoxSimpleMessage,BoxRequestsEvent.LongPollMessageRequest>

Request to begin listening to real-time event notifications. If an event occurs within an account you are monitoring, you will receive a response with the value new_change. It’s important to note that this response will not come with any other details, but should serve as a prompt to take further action such as calling the /events endpoint with your last known stream_position. After sending this response, the server will close the connection and you will need to repeat the long poll process to begin listening for events again. If no events occur for a period of time after you make the GET request to the long poll URL, you will receive a response with the value reconnect. When you receive this response, you’ll make another OPTIONS call to the /events endpoint and repeat the long poll process. If you receive no events in retry_timeout seconds, you should make another GET request to the real time server (i.e. URL in the response). This might be necessary in case you do not receive the reconnect message in the face of network errors. If you receive max_retries error when making GET requests to the real time server, you should make another OPTIONS request.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods, BoxRequest.TLSSSLSocketFactory

Field Summary

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
LongPollMessageRequest(java.lang.String requestUrl, BoxSession session) Creates a long poll request with the default parameters.

Method Summary

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

LongPollMessageRequest

public LongPollMessageRequest(java.lang.String requestUrl,
                              BoxSession session)

Creates a long poll request with the default parameters.

Parameters:

requestUrl - URL to use for long polling.

session - the authenticated session that will be used to make the request with.