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	FIELD_AUTHENTICATED_DOWNLOAD_URL
protected static java.lang.String	LOG_CONTENT_ACCESS_PARAM
static java.lang.String	METADATA_FILE_INFO_TAG
static java.lang.String	METADATA_FOLDER_INFO_TAG
protected static java.lang.String	PREVIEW_AUTHENTICATED_DOWNLOAD_PARAM

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
java.lang.String	getAuthenticatedDownloadUrl(com.box.androidsdk.content.models.BoxFile boxFile)
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)
java.lang.String	getContentUrlNoAccess(java.lang.String fileId)
java.lang.String	getDicomUrl(java.lang.String fileId, java.lang.String fileName)
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 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.
java.lang.String[]	getPreviewFileFields()
java.lang.String	getPreviewUrl(java.lang.String fileId, BoxApiPreview.Extensions ext)
java.lang.String	getPreviewUrlNoAccess(java.lang.String fileId, BoxApiPreview.Extensions ext)
java.lang.String	getRepresentationContentUrl(com.box.androidsdk.content.models.BoxRepresentation representation) Return the string url of a BoxRepresentation

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

getAbortUploadSessionRequest, getAddCommentRequest, getAddTaggedCommentRequest, getAddToCollectionRequest, getCollaborationsRequest, getCommentsRequest, getCommentUrl, getCommitSessionRequest, getCommitSessionRequest, getCopyRequest, getCreateSharedLinkRequest, getCreateUploadSessionRequest, getCreateUploadSessionRequest, getCreateUploadVersionSessionRequest, getCreateUploadVersionSessionRequest, getDeleteFileVersionUrl, getDeleteFromCollectionRequest, getDeleteRequest, getDeleteTrashedFileRequest, getDeleteVersionRequest, getDisableSharedLinkRequest, getDownloadRepresentationRequest, getDownloadRequest, getDownloadRequest, getDownloadThumbnailRequest, getDownloadThumbnailRequest, getDownloadUrlRequest, getEmbedLinkRequest, getFileCollaborationsUrl, getFileCommentsUrl, getFileCopyUrl, getFileDownloadUrl, getFileInfoUrl, getFilePreviewedRequest, getFilesUrl, getFileUploadNewVersionUrl, getFileUploadUrl, getFileVersionsUrl, getInfoRequest, getListUploadSessionRequest, getMoveRequest, getPreviewFileUrl, getPromoteFileVersionUrl, getPromoteVersionRequest, getRenameRequest, getRestoreTrashedFileRequest, getThumbnailFileDownloadUrl, getTrashedFileRequest, getTrashedFileUrl, getUpdateRequest, getUploadNewVersionRequest, getUploadNewVersionRequest, getUploadRequest, getUploadRequest, getUploadSession, getUploadSessionForNewFileUrl, getUploadSessionForNewFileVersionUrl, getUploadSessionInfoUrl, getUploadSessionPartRequest, getUploadSessionPartRequest, 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

METADATA_FOLDER_INFO_TAG

public static final java.lang.String METADATA_FOLDER_INFO_TAG

See Also:

Constant Field Values

FIELD_AUTHENTICATED_DOWNLOAD_URL

public static final java.lang.String FIELD_AUTHENTICATED_DOWNLOAD_URL

See Also:

Constant Field Values

LOG_CONTENT_ACCESS_PARAM

protected static final java.lang.String LOG_CONTENT_ACCESS_PARAM

See Also:

Constant Field Values

PREVIEW_AUTHENTICATED_DOWNLOAD_PARAM

protected static final java.lang.String PREVIEW_AUTHENTICATED_DOWNLOAD_PARAM

See Also:

Constant Field Values

Constructor Detail

BoxApiPreview

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

Method Detail

getPreviewUrl

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

getDicomUrl

public java.lang.String getDicomUrl(java.lang.String fileId,
                                    java.lang.String fileName)

getPreviewUrlNoAccess

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

getContentUrl

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

getContentUrlNoAccess

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

getPreviewFileFields

public java.lang.String[] getPreviewFileFields()

getRepresentationContentUrl

public java.lang.String getRepresentationContentUrl(@NonNull
                                                    com.box.androidsdk.content.models.BoxRepresentation representation)

Return the string url of a BoxRepresentation

Parameters:

representation - BoxRepresentation to be accessed

Returns:

the url to access the media

getAuthenticatedDownloadUrl

public java.lang.String getAuthenticatedDownloadUrl(com.box.androidsdk.content.models.BoxFile boxFile)

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

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.