com.box.androidsdk.preview.ext

Class BoxApiPreview

java.lang.Object

BoxApiFile

com.box.androidsdk.preview.ext.BoxApiPreview

public class BoxApiPreview
extends 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

Constructor Summary

Constructors

Constructor and Description
BoxApiPreview(BoxSession session)

Method Summary

Methods

Modifier and Type	Method and Description
BoxRequestsPreview.GetAudioID3Metadata	getAudioID3MetadataRequest(java.lang.String requestUrl, BoxSession session, BoxFile file, PreviewStorage storage) Returns a request that retrieves the ID3 metadata from the preview endpoint
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
com.box.androidsdk.preview.ext.BoxRequestsPreview.DownloadThumbnail	getDownloadThumbnailJPGRequest(java.io.OutputStream outputStream, java.lang.String fileId) Returns a request that retrieves a JPG thumbnail
static BoxRequestsFile.GetFileInfo	getFileInfoRequest(BoxSession session, BoxFile fileInfo, PreviewStorage storage, BoxApiPreview previewApi) Returns a request that retrieves file information
protected java.lang.String	getFilesUrl()
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)
java.lang.String	getThumbnailJPGUrl(java.lang.String fileId)

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(BoxSession session)

Method Detail

getFilesUrl

protected java.lang.String getFilesUrl()

getPreviewUrl

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

getContentUrl

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

getThumbnailJPGUrl

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

getFileInfoRequest

public static BoxRequestsFile.GetFileInfo getFileInfoRequest(BoxSession session,
                                             BoxFile fileInfo,
                                             PreviewStorage storage,
                                             BoxApiPreview previewApi)

Returns a request that retrieves file information

Parameters:

session - Session to use with the request

fileInfo - The file to get information on

storage - The preview storage used for caching

Returns:

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

getDownloadThumbnailJPGRequest

public com.box.androidsdk.preview.ext.BoxRequestsPreview.DownloadThumbnail getDownloadThumbnailJPGRequest(java.io.OutputStream outputStream,
                                                                                                 java.lang.String fileId)

Returns a request that retrieves a JPG thumbnail

Parameters:

outputStream - output stream to cache the thumnbail to

fileId - file id of the thumbnail to retrieve

Returns:

Request to retrieve the thumbnail

getAudioID3MetadataRequest

public BoxRequestsPreview.GetAudioID3Metadata getAudioID3MetadataRequest(java.lang.String requestUrl,
                                                                BoxSession session,
                                                                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