com.box.androidsdk.content.requests

Class BoxRequestsFile.FilePreviewed

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxVoid,BoxRequestsFile.FilePreviewed>

com.box.androidsdk.content.requests.BoxRequestsFile.FilePreviewed

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.FilePreviewed
extends BoxRequest<BoxVoid,BoxRequestsFile.FilePreviewed>

Request to notify the server when a file is previewed. This request allows the server to maintain a recents list.

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

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
FilePreviewed(java.lang.String fileId, java.lang.String requestUrl, BoxSession session) Constructs an event request with the default parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileId() Retrieve the FileId for this request
protected void	onSendCompleted(BoxResponse<BoxVoid> response) Post action that will be performed after a successful send occurs.

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, 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

FilePreviewed

public FilePreviewed(java.lang.String fileId,
                     java.lang.String requestUrl,
                     BoxSession session)

Constructs an event request with the default parameters.

Parameters:

fileId - Id of the file previewed

requestUrl - URL of the event stream endpoint.

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

Method Detail

getFileId

public java.lang.String getFileId()

Retrieve the FileId for this request

Returns:

the string that represents this file on Box.

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxVoid> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxVoid,BoxRequestsFile.FilePreviewed>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.