com.box.androidsdk.preview.ext

Class BoxApiPreview

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiFile

com.box.androidsdk.preview.ext.BoxApiPreview

public class BoxApiPreview
extends com.box.androidsdk.content.BoxApiFile

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxApiPreview.Extensions Enumeration of all preview supported extensions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_FILE_INFO_TAG
static java.lang.String	TAG

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

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiPreview(com.box.androidsdk.content.models.BoxSession session)

Method Summary

Modifier and Type	Method and Description
BoxRequestsPreview.GetAudioID3Metadata	getAudioID3MetadataRequest(java.lang.String requestUrl, com.box.androidsdk.content.models.BoxSession session, com.box.androidsdk.content.models.BoxFile file, PreviewStorage storage) Returns a request that retrieves the ID3 metadata from the preview endpoint
BoxRequestsPreview.CheckFileConsistency	getCheckFileConsistencyRequest(java.lang.String fileId, java.lang.String versionId, BoxApiPreview.Extensions ext) Returns a request that we will use to check file consistency.
java.lang.String	getContentUrl(java.lang.String fileId)
BoxRequestsPreview.DownloadPreview	getDownloadPreviewRequest(java.io.OutputStream outputStream, java.lang.String fileId, BoxApiPreview.Extensions ext) Returns a request that retrieves and caches a preview
static com.box.androidsdk.content.requests.BoxRequestsFile.GetFileInfo	getFileInfoRequest(PreviewController previewController, com.box.androidsdk.content.models.BoxFile fileInfo) Returns a request that retrieves file information
protected java.lang.String	getFilesUrl()
protected BoxRequestsPreview.PreviewBatchRequest	getOfflineRequests(PreviewController previewController, com.box.androidsdk.content.models.BoxFile boxFile) Returns a preview batch request that contains a number of individual requests that are required to view the given file offline.
BoxRequestsPreview.PollForConversionReady	getPollForConversionReadyRequest(java.lang.String fileId, BoxApiPreview.Extensions ext) Returns a request that will poll the preview endpoint to check if the conversion of a preview is complete.
java.lang.String	getPreviewUrl(java.lang.String fileId, BoxApiPreview.Extensions ext)

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

getAddCommentRequest, getAddTaggedCommentRequest, getAddToCollectionRequest, getCommentsRequest, getCommentUrl, getCopyRequest, getCreateSharedLinkRequest, getDeleteFileVersionUrl, getDeleteFromCollectionRequest, getDeleteRequest, getDeleteTrashedFileRequest, getDeleteVersionRequest, getDisableSharedLinkRequest, getDownloadRequest, getDownloadRequest, getDownloadThumbnailRequest, getDownloadThumbnailRequest, getDownloadUrlRequest, getEmbedLinkRequest, getFileCommentsUrl, getFileCopyUrl, getFileDownloadUrl, getFileInfoUrl, getFileUploadNewVersionUrl, getFileUploadUrl, getFileVersionsUrl, getInfoRequest, getMoveRequest, getPromoteFileVersionUrl, getPromoteVersionRequest, getRenameRequest, getRestoreTrashedFileRequest, getThumbnailFileDownloadUrl, getTrashedFileRequest, getTrashedFileUrl, getUpdateRequest, getUploadNewVersionRequest, getUploadNewVersionRequest, getUploadRequest, getUploadRequest, getVersionsRequest

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

METADATA_FILE_INFO_TAG

public static final java.lang.String METADATA_FILE_INFO_TAG

See Also:

Constant Field Values

TAG

public static final java.lang.String TAG

Constructor Detail

BoxApiPreview

public BoxApiPreview(com.box.androidsdk.content.models.BoxSession session)

Method Detail

getFilesUrl

protected java.lang.String getFilesUrl()

Overrides:

getFilesUrl in class com.box.androidsdk.content.BoxApiFile

getPreviewUrl

public java.lang.String getPreviewUrl(java.lang.String fileId,
                                      BoxApiPreview.Extensions ext)

getContentUrl

public java.lang.String getContentUrl(java.lang.String fileId)

getFileInfoRequest

public static com.box.androidsdk.content.requests.BoxRequestsFile.GetFileInfo getFileInfoRequest(PreviewController previewController,
                                                                                                 com.box.androidsdk.content.models.BoxFile fileInfo)

Returns a request that retrieves file information

Parameters:

previewController - Controller to use for requests.

fileInfo - The file to get information on

Returns:

file information for the requested item.

getDownloadPreviewRequest

public BoxRequestsPreview.DownloadPreview getDownloadPreviewRequest(java.io.OutputStream outputStream,
                                                                    java.lang.String fileId,
                                                                    BoxApiPreview.Extensions ext)

Returns a request that retrieves and caches a preview

Parameters:

outputStream - the output stream to cache the preview to

fileId - the file id of the preview to retrieve

ext - extension of the preview

Returns:

Request to retrieve the preview

getAudioID3MetadataRequest

public BoxRequestsPreview.GetAudioID3Metadata getAudioID3MetadataRequest(java.lang.String requestUrl,
                                                                         com.box.androidsdk.content.models.BoxSession session,
                                                                         com.box.androidsdk.content.models.BoxFile file,
                                                                         PreviewStorage storage)

Returns a request that retrieves the ID3 metadata from the preview endpoint

Parameters:

requestUrl - The preview url for the mp3 file

session - The session to use to retrieve the information with

file - The file to retrieve metadata for

storage - The storage class to use for caching the information

Returns:

Request to retrieve ID3 metadata

getPollForConversionReadyRequest

public BoxRequestsPreview.PollForConversionReady getPollForConversionReadyRequest(java.lang.String fileId,
                                                                                  BoxApiPreview.Extensions ext)

Returns a request that will poll the preview endpoint to check if the conversion of a preview is complete. This uses the standard exponential back off provided with the box-android-sdk. The response will be returned when an OK status code is returned or the max wait time is reached.

Parameters:

fileId - Id of the file to check

ext - extension to check preview endpoint with

Returns:

Check conversion status request

getCheckFileConsistencyRequest

public BoxRequestsPreview.CheckFileConsistency getCheckFileConsistencyRequest(java.lang.String fileId,
                                                                              java.lang.String versionId,
                                                                              BoxApiPreview.Extensions ext)

Returns a request that we will use to check file consistency. Currently, we are primarily using this to verify that a cached document has not changed size before we open it in PSPDFKit.

Parameters:

fileId - The id of the file to check

versionId - The version of the file to check

ext - The extension of the preview to request.

Returns:

File consistency check request

getOfflineRequests

protected BoxRequestsPreview.PreviewBatchRequest getOfflineRequests(PreviewController previewController,
                                                                    com.box.androidsdk.content.models.BoxFile boxFile)

Returns a preview batch request that contains a number of individual requests that are required to view the given file offline.

Parameters:

boxFile - the file to save for offline.

previewController - the preview controller to use for storage and api implementations.

Returns:

a batch request that will offline the given box file.