com.box.androidsdk.content

Class BoxApiFile

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiFile

public class BoxApiFile
extends BoxApi

Represents the API of the file endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

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

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiFile(BoxSession session) Constructs a BoxApiFile with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsFile.AddCommentToFile	getAddCommentRequest(java.lang.String fileId, java.lang.String message) Gets a request that adds a comment to a file
BoxRequestsFile.AddTaggedCommentToFile	getAddTaggedCommentRequest(java.lang.String fileId, java.lang.String taggedMessage) Gets a request for adding a comment with tags that mention users.
BoxRequestsFile.AddFileToCollection	getAddToCollectionRequest(java.lang.String fileId, java.lang.String collectionId) Gets a request that adds a file to a collection
BoxRequestsFile.GetFileComments	getCommentsRequest(java.lang.String id) Gets a request that retrieves the comments on a file
protected java.lang.String	getCommentUrl() Gets the URL for posting a comment on a file
BoxRequestsFile.CopyFile	getCopyRequest(java.lang.String id, java.lang.String parentId) Gets a request that copies a file
BoxRequestsFile.UpdatedSharedFile	getCreateSharedLinkRequest(java.lang.String id) Gets a request that creates a shared link for a file
protected java.lang.String	getDeleteFileVersionUrl(java.lang.String id, java.lang.String versionId) Gets the URL for deleting the version of a file
BoxRequestsFile.DeleteFileFromCollection	getDeleteFromCollectionRequest(java.lang.String id) Gets a request that removes a file from a collection
BoxRequestsFile.DeleteFile	getDeleteRequest(java.lang.String id) Gets a request that deletes a folder
BoxRequestsFile.DeleteTrashedFile	getDeleteTrashedFileRequest(java.lang.String id) Gets a request that permanently deletes a file from the trash
BoxRequestsFile.DeleteFileVersion	getDeleteVersionRequest(java.lang.String id, java.lang.String versionId) Gets a request that deletes a version of a file
BoxRequestsFile.UpdateFile	getDisableSharedLinkRequest(java.lang.String id) Gets a request that disables a shared link for a folder
BoxRequestsFile.DownloadFile	getDownloadRequest(java.io.File target, java.lang.String fileId) Gets a request that downloads a given file to a target file
BoxRequestsFile.DownloadFile	getDownloadRequest(java.io.OutputStream outputStream, java.lang.String fileId) Gets a request that downloads the given file to the provided outputStream.
BoxRequestsFile.DownloadThumbnail	getDownloadThumbnailRequest(java.io.File target, java.lang.String fileId) Gets a request that downloads a thumbnail to a target file
BoxRequestsFile.DownloadThumbnail	getDownloadThumbnailRequest(java.io.OutputStream outputStream, java.lang.String fileId) Gets a request that downloads the given file thumbnail to the provided outputStream.
BoxRequestsFile.DownloadFile	getDownloadUrlRequest(java.io.File target, java.lang.String url) Gets a request that downloads a given asset from the url to a target file This is used to download miscellaneous url assets for instance from the representations endpoint.
BoxRequestsFile.GetEmbedLinkFileInfo	getEmbedLinkRequest(java.lang.String id) Gets a request that retrieves an expiring embedded link which can be embedded in a webview for a preview.
protected java.lang.String	getFileCommentsUrl(java.lang.String id) Gets the URL for comments on a file
protected java.lang.String	getFileCopyUrl(java.lang.String id) Gets the URL for copying a file
protected java.lang.String	getFileDownloadUrl(java.lang.String id) Gets the URL for downloading a file
protected java.lang.String	getFileInfoUrl(java.lang.String id) Gets the URL for file information
BoxRequestsFile.FilePreviewed	getFilePreviewedRequest(java.lang.String fileId) Gets a request that inform the server that a file was previewed.
protected java.lang.String	getFilesUrl() Gets the URL for files
protected java.lang.String	getFileUploadNewVersionUrl(java.lang.String id) Gets the URL for uploading a new version of a file
protected java.lang.String	getFileUploadUrl() Gets the URL for uploading a file
protected java.lang.String	getFileVersionsUrl(java.lang.String id) Gets the URL for versions of a file
BoxRequestsFile.GetFileInfo	getInfoRequest(java.lang.String id) Gets a request that retrieves information on a file
BoxRequestsFile.UpdateFile	getMoveRequest(java.lang.String id, java.lang.String parentId) Gets a request that moves a file to another folder
protected java.lang.String	getPreviewFileUrl() Get the URL to inform that a file was previewed
protected java.lang.String	getPromoteFileVersionUrl(java.lang.String id) Gets the URL for promoting the version of a file
BoxRequestsFile.PromoteFileVersion	getPromoteVersionRequest(java.lang.String id, java.lang.String versionId) Gets a request that promotes a version to the top of the version stack for a file.
BoxRequestsFile.UpdateFile	getRenameRequest(java.lang.String id, java.lang.String newName) Gets a request that renames a file
BoxRequestsFile.RestoreTrashedFile	getRestoreTrashedFileRequest(java.lang.String id) Gets a request that restores a trashed file
protected java.lang.String	getThumbnailFileDownloadUrl(java.lang.String id) Gets the URL for downloading the thumbnail of a file
BoxRequestsFile.GetTrashedFile	getTrashedFileRequest(java.lang.String id) Gets a request that returns a file in the trash
protected java.lang.String	getTrashedFileUrl(java.lang.String id) Gets the URL for comments on a file
BoxRequestsFile.UpdateFile	getUpdateRequest(java.lang.String id) Gets a request that updates a file's information
BoxRequestsFile.UploadNewVersion	getUploadNewVersionRequest(java.io.File file, java.lang.String destinationFileId) Gets a request that uploads a new file version from an existing file
BoxRequestsFile.UploadNewVersion	getUploadNewVersionRequest(java.io.InputStream fileInputStream, java.lang.String destinationFileId) Gets a request that uploads a new file version from an input stream
BoxRequestsFile.UploadFile	getUploadRequest(java.io.File file, java.lang.String destinationFolderId) Gets a request that uploads a file from an existing file
BoxRequestsFile.UploadFile	getUploadRequest(java.io.InputStream fileInputStream, java.lang.String fileName, java.lang.String destinationFolderId) Gets a request that uploads a file from an input stream
BoxRequestsFile.GetFileVersions	getVersionsRequest(java.lang.String id) Gets a request that retrieves the versions of a file

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

Constructor Detail

BoxApiFile

public BoxApiFile(BoxSession session)

Constructs a BoxApiFile with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiFile

Method Detail

getFilesUrl

protected java.lang.String getFilesUrl()

Gets the URL for files

Returns:

the file URL

getFileInfoUrl

protected java.lang.String getFileInfoUrl(java.lang.String id)

Gets the URL for file information

Parameters:

id - id of the file

Returns:

the file information URL

getFileCopyUrl

protected java.lang.String getFileCopyUrl(java.lang.String id)

Gets the URL for copying a file

Parameters:

id - id of the file

Returns:

the copy file URL

getFileUploadUrl

protected java.lang.String getFileUploadUrl()

Gets the URL for uploading a file

Returns:

the file upload URL

getFileUploadNewVersionUrl

protected java.lang.String getFileUploadNewVersionUrl(java.lang.String id)

Gets the URL for uploading a new version of a file

Parameters:

id - id of the file

Returns:

the file version upload URL

getTrashedFileUrl

protected java.lang.String getTrashedFileUrl(java.lang.String id)

Gets the URL for comments on a file

Parameters:

id - id of the file

Returns:

the file comments URL

getFileCommentsUrl

protected java.lang.String getFileCommentsUrl(java.lang.String id)

Gets the URL for comments on a file

Parameters:

id - id of the file

Returns:

the file comments URL

getFileVersionsUrl

protected java.lang.String getFileVersionsUrl(java.lang.String id)

Gets the URL for versions of a file

Parameters:

id - id of the file

Returns:

the file versions URL

getPromoteFileVersionUrl

protected java.lang.String getPromoteFileVersionUrl(java.lang.String id)

Gets the URL for promoting the version of a file

Parameters:

id - id of the file

Returns:

the file version promotion URL

getDeleteFileVersionUrl

protected java.lang.String getDeleteFileVersionUrl(java.lang.String id,
                                                   java.lang.String versionId)

Gets the URL for deleting the version of a file

Parameters:

id - id of the file

versionId - versionId of the file to delete

Returns:

the file version deletion URL

getFileDownloadUrl

protected java.lang.String getFileDownloadUrl(java.lang.String id)

Gets the URL for downloading a file

Parameters:

id - id of the file

Returns:

the file download URL

getThumbnailFileDownloadUrl

protected java.lang.String getThumbnailFileDownloadUrl(java.lang.String id)

Gets the URL for downloading the thumbnail of a file

Parameters:

id - id of the file

Returns:

the thumbnail file download URL

getCommentUrl

protected java.lang.String getCommentUrl()

Gets the URL for posting a comment on a file

Returns:

the comments URL

getPreviewFileUrl

protected java.lang.String getPreviewFileUrl()

Get the URL to inform that a file was previewed

Returns:

the preview file URL

getInfoRequest

public BoxRequestsFile.GetFileInfo getInfoRequest(java.lang.String id)

Gets a request that retrieves information on a file

Parameters:

id - id of file to retrieve info on

Returns:

request to get a files information

getEmbedLinkRequest

public BoxRequestsFile.GetEmbedLinkFileInfo getEmbedLinkRequest(java.lang.String id)

Gets a request that retrieves an expiring embedded link which can be embedded in a webview for a preview.

Parameters:

id - id of file to retrieve info on

Returns:

request to get a files information

getUpdateRequest

public BoxRequestsFile.UpdateFile getUpdateRequest(java.lang.String id)

Gets a request that updates a file's information

Parameters:

id - id of file to update information on

Returns:

request to update a file's information

getCopyRequest

public BoxRequestsFile.CopyFile getCopyRequest(java.lang.String id,
                                               java.lang.String parentId)

Gets a request that copies a file

Parameters:

id - id of the file to copy

parentId - id of the parent folder to copy the file into

Returns:

request to copy a file

getRenameRequest

public BoxRequestsFile.UpdateFile getRenameRequest(java.lang.String id,
                                                   java.lang.String newName)

Gets a request that renames a file

Parameters:

id - id of file to rename

newName - id of file to retrieve info on

Returns:

request to rename a file

getMoveRequest

public BoxRequestsFile.UpdateFile getMoveRequest(java.lang.String id,
                                                 java.lang.String parentId)

Gets a request that moves a file to another folder

Parameters:

id - id of file to move

parentId - id of parent folder to move file into

Returns:

request to move a file

getDeleteRequest

public BoxRequestsFile.DeleteFile getDeleteRequest(java.lang.String id)

Gets a request that deletes a folder

Parameters:

id - id of folder to delete

Returns:

request to delete a folder

getCreateSharedLinkRequest

public BoxRequestsFile.UpdatedSharedFile getCreateSharedLinkRequest(java.lang.String id)

Gets a request that creates a shared link for a file

Parameters:

id - id of file to create shared link for

Returns:

request to create a shared link for a file

getDisableSharedLinkRequest

public BoxRequestsFile.UpdateFile getDisableSharedLinkRequest(java.lang.String id)

Gets a request that disables a shared link for a folder

Parameters:

id - id of folder to disable a shared link for

Returns:

request to create a shared link for a folder

getAddCommentRequest

public BoxRequestsFile.AddCommentToFile getAddCommentRequest(java.lang.String fileId,
                                                             java.lang.String message)

Gets a request that adds a comment to a file

Parameters:

fileId - id of the file to add the comment to

message - message for the comment that will be added

Returns:

request to add a comment to a file

getAddTaggedCommentRequest

public BoxRequestsFile.AddTaggedCommentToFile getAddTaggedCommentRequest(java.lang.String fileId,
                                                                         java.lang.String taggedMessage)

Gets a request for adding a comment with tags that mention users. The server will notify mentioned users of the comment. Tagged users must be collaborators of the parent folder. Format for adding a tag @[userid:username], E.g. "Hello @[12345:Jane Doe]" will create a comment 'Hello Jane Doe', and notify Jane that she has been mentioned.

Parameters:

fileId - id of the file to add the comment to

taggedMessage - message for the comment that will be added

Returns:

request to add a comment to a file

getUploadRequest

public BoxRequestsFile.UploadFile getUploadRequest(java.io.InputStream fileInputStream,
                                                   java.lang.String fileName,
                                                   java.lang.String destinationFolderId)

Gets a request that uploads a file from an input stream

Parameters:

fileInputStream - input stream of the file

fileName - name of the new file

destinationFolderId - id of the parent folder for the new file

Returns:

request to upload a file from an input stream

getUploadRequest

public BoxRequestsFile.UploadFile getUploadRequest(java.io.File file,
                                                   java.lang.String destinationFolderId)

Gets a request that uploads a file from an existing file

Parameters:

file - file to upload

destinationFolderId - id of the parent folder for the new file

Returns:

request to upload a file from an existing file

getUploadNewVersionRequest

public BoxRequestsFile.UploadNewVersion getUploadNewVersionRequest(java.io.InputStream fileInputStream,
                                                                   java.lang.String destinationFileId)

Gets a request that uploads a new file version from an input stream

Parameters:

fileInputStream - input stream of the new file version

destinationFileId - id of the file to upload a new version of

Returns:

request to upload a new file version from an input stream

getUploadNewVersionRequest

public BoxRequestsFile.UploadNewVersion getUploadNewVersionRequest(java.io.File file,
                                                                   java.lang.String destinationFileId)

Gets a request that uploads a new file version from an existing file

Parameters:

file - file to upload as a new version

destinationFileId - id of the file to upload a new version of

Returns:

request to upload a new file version from an existing file

getDownloadRequest

public BoxRequestsFile.DownloadFile getDownloadRequest(java.io.File target,
                                                       java.lang.String fileId)
                                                throws java.io.IOException

Gets a request that downloads a given file to a target file

Parameters:

target - target file to download to, target can be either a directory or a file

fileId - id of the file to download

Returns:

request to download a file to a target file

Throws:

java.io.IOException - throws FileNotFoundException if target file does not exist.

getDownloadUrlRequest

public BoxRequestsFile.DownloadFile getDownloadUrlRequest(java.io.File target,
                                                          java.lang.String url)
                                                   throws java.io.IOException

Gets a request that downloads a given asset from the url to a target file This is used to download miscellaneous url assets for instance from the representations endpoint.

Parameters:

target - target file to download to, target can be either a directory or a file

url - url of the asset to download

Returns:

request to download a file to a target file

Throws:

java.io.IOException - throws FileNotFoundException if target file does not exist.

getDownloadRequest

public BoxRequestsFile.DownloadFile getDownloadRequest(java.io.OutputStream outputStream,
                                                       java.lang.String fileId)

Gets a request that downloads the given file to the provided outputStream. Developer is responsible for closing the outputStream provided.

Parameters:

outputStream - outputStream to write file contents to.

fileId - the file id to download.

Returns:

request to download a file to an output stream

getDownloadThumbnailRequest

public BoxRequestsFile.DownloadThumbnail getDownloadThumbnailRequest(java.io.File target,
                                                                     java.lang.String fileId)
                                                              throws java.io.IOException

Gets a request that downloads a thumbnail to a target file

Parameters:

target - target file to download to, target can be either a directory or a file

fileId - id of file to download the thumbnail of

Returns:

request to download a thumbnail to a target file

Throws:

java.io.IOException - throws FileNotFoundException if target file does not exist.

getDownloadThumbnailRequest

public BoxRequestsFile.DownloadThumbnail getDownloadThumbnailRequest(java.io.OutputStream outputStream,
                                                                     java.lang.String fileId)

Gets a request that downloads the given file thumbnail to the provided outputStream. Developer is responsible for closing the outputStream provided.

Parameters:

outputStream - outputStream to write file contents to.

fileId - the file id to download.

Returns:

request to download a file thumbnail

getTrashedFileRequest

public BoxRequestsFile.GetTrashedFile getTrashedFileRequest(java.lang.String id)

Gets a request that returns a file in the trash

Parameters:

id - id of file to get in the trash

Returns:

request to get a file from the trash

getDeleteTrashedFileRequest

public BoxRequestsFile.DeleteTrashedFile getDeleteTrashedFileRequest(java.lang.String id)

Gets a request that permanently deletes a file from the trash

Parameters:

id - id of file to delete from the trash

Returns:

request to permanently delete a file from the trash

getRestoreTrashedFileRequest

public BoxRequestsFile.RestoreTrashedFile getRestoreTrashedFileRequest(java.lang.String id)

Gets a request that restores a trashed file

Parameters:

id - id of file to restore

Returns:

request to restore a file from the trash

getCommentsRequest

public BoxRequestsFile.GetFileComments getCommentsRequest(java.lang.String id)

Gets a request that retrieves the comments on a file

Parameters:

id - id of the file to retrieve comments for

Returns:

request to retrieve comments on a file

getVersionsRequest

public BoxRequestsFile.GetFileVersions getVersionsRequest(java.lang.String id)

Gets a request that retrieves the versions of a file

Parameters:

id - id of the file to retrieve file versions for

Returns:

request to retrieve versions of a file

getPromoteVersionRequest

public BoxRequestsFile.PromoteFileVersion getPromoteVersionRequest(java.lang.String id,
                                                                   java.lang.String versionId)

Gets a request that promotes a version to the top of the version stack for a file. This will create a copy of the old version to put on top of the version stack. The file will have the exact same contents, the same SHA1/etag, and the same name as the original. Other properties such as comments do not get updated to their former values.

Parameters:

id - id of the file to promote the version of

versionId - id of the file version to promote to the top

Returns:

request to promote a version of a file

getDeleteVersionRequest

public BoxRequestsFile.DeleteFileVersion getDeleteVersionRequest(java.lang.String id,
                                                                 java.lang.String versionId)

Gets a request that deletes a version of a file

Parameters:

id - id of the file to delete a version of

versionId - id of the file version to delete

Returns:

request to delete a file version

getAddToCollectionRequest

public BoxRequestsFile.AddFileToCollection getAddToCollectionRequest(java.lang.String fileId,
                                                                     java.lang.String collectionId)

Gets a request that adds a file to a collection

Parameters:

fileId - id of file to add to collection

collectionId - id of collection to add the file to

Returns:

request to add a file to a collection

getDeleteFromCollectionRequest

public BoxRequestsFile.DeleteFileFromCollection getDeleteFromCollectionRequest(java.lang.String id)

Gets a request that removes a file from a collection

Parameters:

id - id of file to delete from the collection

Returns:

request to delete a file from a collection

getFilePreviewedRequest

public BoxRequestsFile.FilePreviewed getFilePreviewedRequest(java.lang.String fileId)

Gets a request that inform the server that a file was previewed. This makes the file to be included on the recents list.

Parameters:

fileId -

Returns:

request to inform the server that a file was previewed