com.fangcloud.sdk.api.file

Class YfyFileRequest

java.lang.Object

com.fangcloud.sdk.api.file.YfyFileRequest

public class YfyFileRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
YfyFileRequest(YfyBaseClient.YfyInternalClient client)

Method Summary

Methods

Modifier and Type	Method and Description
YfyFile	copyFile(long fileId, long targetFolderId) Copy the specific file to a folder
SuccessResult	deleteFile(long fileId) Discard a file to the trash
SuccessResult	deleteFileFromTrash(long fileId) Permanently delete a specific file that is in the trash.
void	directDownloadFile(long fileId, String savePath) Combine the preSignatureDownload(long) and downloadFile(String,String) method, direct download the file
InputStream	directDownloadFileStream(long fileId) Combine the preSignatureDownload(long) and downloadFile(String,String) method, direct get a InputStream of the file
YfyFile	directUploadFile(long parentId, String name, InputStream fileStream) Combine the this#preSignatureUpload(long, String) and this#uploadFile(String,InputStream) method, direct upload the file
YfyFile	directUploadFile(long parentId, String name, String filePath) Combine the this#preSignatureUpload(long, String) and this#uploadFile(String,InputStream) method, direct upload the file
YfyFile	directUploadNewVersionFile(long fileId, String name, String remark, InputStream fileStream) Combine the this#newVersionPreSignatureUpload(long,String,String) and this#uploadFile(String,InputStream) method, direct upload the new version file
YfyFile	directUploadNewVersionFile(long fileId, String name, String remark, String filePath) Combine the this#newVersionPreSignatureUpload(long,String,String) and this#uploadFile(String,InputStream) method, direct upload the new version file
void	downloadFile(String downloadUrl, String savePath) When get a file download url, use this method to save the file to the certain path
void	downloadFile(String downloadUrl, String savePath, YfyProgressListener progressListener) When get a file download url, use this method to save the file to the certain path
InputStream	downloadFileStream(String downloadUrl) When get a file download url, use this method to get a InputStream of the file
InputStream	downloadFileStream(String downloadUrl, YfyProgressListener progressListener) When get a file download url, use this method to get a InputStream of the file
DownloadPreviewResult	downloadPreview(long fileId, int pageIndex, PreviewKindEnum previewKind) Retrieve download url if the page count of result to this#preview(long,PreviewKindEnum,boolean) more than 1.
YfyFile	getFile(long fileId) Retrieve file info
ListCommentResult	listComment(long fileId) List file's all comments' information
ListShareLinkResult	listShareLink(long fileId, int pageId) List share links of a file
ListShareLinkResult	listShareLink(long fileId, int pageId, long ownerId) List file's share links created by specific owner
SuccessResult	moveFile(long fileId, long targetFolderId) Move a file to another folder
String	newVersionPreSignatureUpload(long fileId, String name, String remark) Get the new version file upload url, then use the url to upload new version file.
String	preSignatureDownload(long fileId) Get file download url, then use the url to download file.
String	preSignatureUpload(long parentId, String name) Get the file upload url, then use the url to upload file.
PreviewResult	preview(long fileId, PreviewKindEnum previewKind, boolean forceRegenerate) Retrieve preview image information and download url
SuccessResult	restoreFileFromTrash(long fileId) Restore a file that has been moved to the trash.
YfyFile	updateFile(long fileId, String newName, String newDescription) Update fields in file, including file name and file description
YfyFile	uploadFile(String uploadUrl, InputStream fileStream) When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)
YfyFile	uploadFile(String uploadUrl, InputStream fileStream, long fileSize, YfyProgressListener progressListener) When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)
YfyFile	uploadFile(String uploadUrl, String filePath) When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)
YfyFile	uploadFile(String uploadUrl, String filePath, long fileSize, YfyProgressListener progressListener) When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YfyFileRequest

public YfyFileRequest(YfyBaseClient.YfyInternalClient client)

Method Detail

getFile

public YfyFile getFile(long fileId)
                throws YfyException

Retrieve file info

Parameters:

fileId - File id in fangcloud

Returns:

Detailed file's information

Throws:

YfyException

updateFile

public YfyFile updateFile(long fileId,
                 String newName,
                 String newDescription)
                   throws YfyException

Update fields in file, including file name and file description

Parameters:

fileId - File id in fangcloud

newName - File new name, can not be null

newDescription - File new description, can be null

Returns:

Detailed file's information

Throws:

YfyException

deleteFile

public SuccessResult deleteFile(long fileId)
                         throws YfyException

Discard a file to the trash

Parameters:

fileId - File id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

deleteFileFromTrash

public SuccessResult deleteFileFromTrash(long fileId)
                                  throws YfyException

Permanently delete a specific file that is in the trash. The file will no longer exist in fangcloud. This action cannot be undone.

Parameters:

fileId - File id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

restoreFileFromTrash

public SuccessResult restoreFileFromTrash(long fileId)
                                   throws YfyException

Restore a file that has been moved to the trash. Default behavior is to restore the file to the folder it was in before it was moved to the trash

Parameters:

fileId - File id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

moveFile

public SuccessResult moveFile(long fileId,
                     long targetFolderId)
                       throws YfyException

Move a file to another folder

Parameters:

fileId - File id in fangcloud

targetFolderId - Folder id of the destination folder in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

preSignatureDownload

public String preSignatureDownload(long fileId)
                            throws YfyException

Get file download url, then use the url to download file. The url is valid in an hour

Parameters:

fileId - File id in fangcloud

Returns:

Download url of the file

Throws:

YfyException

downloadFile

public void downloadFile(String downloadUrl,
                String savePath)
                  throws YfyException

When get a file download url, use this method to save the file to the certain path

Parameters:

downloadUrl - Download url returned by the preSignatureDownload(long)

savePath - Where you'd like to save the file

Throws:

YfyException

downloadFile

public void downloadFile(String downloadUrl,
                String savePath,
                YfyProgressListener progressListener)
                  throws YfyException

When get a file download url, use this method to save the file to the certain path

Parameters:

downloadUrl - Download url returned by the preSignatureDownload(long)

savePath - Where you'd like to save the file

progressListener - Where get file upload progress

Throws:

YfyException

downloadFileStream

public InputStream downloadFileStream(String downloadUrl)
                               throws YfyException

When get a file download url, use this method to get a InputStream of the file

Parameters:

downloadUrl - Download url returned by the preSignatureDownload(long)

Returns:

InputStream of the file to be downloaded

Throws:

YfyException

downloadFileStream

public InputStream downloadFileStream(String downloadUrl,
                             YfyProgressListener progressListener)
                               throws YfyException

When get a file download url, use this method to get a InputStream of the file

Parameters:

downloadUrl - Download url returned by the preSignatureDownload(long)

progressListener - Where get file upload progress

Returns:

InputStream of the file to be downloaded

Throws:

YfyException

directDownloadFile

public void directDownloadFile(long fileId,
                      String savePath)
                        throws YfyException

Combine the preSignatureDownload(long) and downloadFile(String,String) method, direct download the file

Parameters:

fileId - File id in fangcloud

savePath - Where you'd like to save the file

Throws:

YfyException

directDownloadFileStream

public InputStream directDownloadFileStream(long fileId)
                                     throws YfyException

Combine the preSignatureDownload(long) and downloadFile(String,String) method, direct get a InputStream of the file

Parameters:

fileId - File id in fangcloud

Returns:

InputStream of the file to be downloaded

Throws:

YfyException

preSignatureUpload

public String preSignatureUpload(long parentId,
                        String name)
                          throws YfyException

Get the file upload url, then use the url to upload file. The url is valid in an hour and can only be used for one time

Parameters:

parentId - Parent folder id you want to store the file in, the root folder is 0

name - File name

Returns:

Upload url of the file

Throws:

YfyException

newVersionPreSignatureUpload

public String newVersionPreSignatureUpload(long fileId,
                                  String name,
                                  String remark)
                                    throws YfyException

Get the new version file upload url, then use the url to upload new version file. The url is valid in an hour and can only be used for one time

Parameters:

fileId - Origin file id in fangcloud

name - File name of the new version

remark - remark of the new version

Returns:

An object contains a attribute named upload url

Throws:

YfyException

uploadFile

public YfyFile uploadFile(String uploadUrl,
                 String filePath)
                   throws YfyException,
                          FileNotFoundException

When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)

Parameters:

uploadUrl - Upload url returned by the this#preSignatureUpload(long,String)

filePath - Path of the file which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

FileNotFoundException

uploadFile

public YfyFile uploadFile(String uploadUrl,
                 String filePath,
                 long fileSize,
                 YfyProgressListener progressListener)
                   throws YfyException,
                          FileNotFoundException

When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)

Parameters:

uploadUrl - Upload url returned by the this#preSignatureUpload(long,String)

filePath - Path of the file which you'd like to upload to server

fileSize - The size of file

progressListener - Where get file upload progress

Returns:

Detailed new file information

Throws:

YfyException

FileNotFoundException

uploadFile

public YfyFile uploadFile(String uploadUrl,
                 InputStream fileStream)
                   throws YfyException

When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)

Parameters:

uploadUrl - Upload url returned by the this#preSignatureUpload(long,String)

fileStream - The file stream which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

uploadFile

public YfyFile uploadFile(String uploadUrl,
                 InputStream fileStream,
                 long fileSize,
                 YfyProgressListener progressListener)
                   throws YfyException

When get a file upload url, use this method to upload the file to the server (note that real file name used name in pre signature arg)

Parameters:

uploadUrl - Upload url returned by the this#preSignatureUpload(long,String)

fileStream - The file stream which you'd like to upload to server

fileSize - The size of file

progressListener - Where get file upload progress

Returns:

Detailed new file information

Throws:

YfyException

directUploadFile

public YfyFile directUploadFile(long parentId,
                       String name,
                       String filePath)
                         throws YfyException,
                                FileNotFoundException

Combine the this#preSignatureUpload(long, String) and this#uploadFile(String,InputStream) method, direct upload the file

Parameters:

parentId - Parent folder id you want to store the file in, the root folder is 0

name - File name

filePath - Path of the file which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

FileNotFoundException

directUploadFile

public YfyFile directUploadFile(long parentId,
                       String name,
                       InputStream fileStream)
                         throws YfyException

Combine the this#preSignatureUpload(long, String) and this#uploadFile(String,InputStream) method, direct upload the file

Parameters:

parentId - Parent folder id you want to store the file in, the root folder is 0

name - File name

fileStream - The file stream which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

directUploadNewVersionFile

public YfyFile directUploadNewVersionFile(long fileId,
                                 String name,
                                 String remark,
                                 String filePath)
                                   throws YfyException,
                                          FileNotFoundException

Combine the this#newVersionPreSignatureUpload(long,String,String) and this#uploadFile(String,InputStream) method, direct upload the new version file

Parameters:

fileId - File id that you want to upload the new version to

name - New version file name

remark - Remark of the new version

filePath - Path of the file which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

FileNotFoundException

directUploadNewVersionFile

public YfyFile directUploadNewVersionFile(long fileId,
                                 String name,
                                 String remark,
                                 InputStream fileStream)
                                   throws YfyException

Combine the this#newVersionPreSignatureUpload(long,String,String) and this#uploadFile(String,InputStream) method, direct upload the new version file

Parameters:

fileId - File id that you want to upload the new version to

name - New version file name

remark - Remark of the new version

fileStream - The file stream which you'd like to upload to server

Returns:

Detailed new file information

Throws:

YfyException

preview

public PreviewResult preview(long fileId,
                    PreviewKindEnum previewKind,
                    boolean forceRegenerate)
                      throws YfyException

Retrieve preview image information and download url

Parameters:

fileId - File id in fangcloud

previewKind - The kinds of preview, see PreviewKindEnum

forceRegenerate - if true, the preview image will regenerate force

Returns:

Information about the preview result

Throws:

YfyException

downloadPreview

public DownloadPreviewResult downloadPreview(long fileId,
                                    int pageIndex,
                                    PreviewKindEnum previewKind)
                                      throws YfyException

Retrieve download url if the page count of result to this#preview(long,PreviewKindEnum,boolean) more than 1. Notice this interface will not trigger preview transform.

Parameters:

fileId - File id in fangcloud

pageIndex - Less than the page count return by this#preview(long,PreviewKindEnum,boolean)

previewKind - The kinds of preview, see PreviewKindEnum

Returns:

Download url means success. Status attribute value "failed" means generating preview fail, "ungenerated" means not invoke this#preview(long,PreviewKindEnum,boolean) before

Throws:

YfyException

copyFile

public YfyFile copyFile(long fileId,
               long targetFolderId)
                 throws YfyException

Copy the specific file to a folder

Parameters:

fileId - File id in fangcloud

targetFolderId - Id of the destination folder in fangcloud

Returns:

Detailed new file's information

Throws:

YfyException

listShareLink

public ListShareLinkResult listShareLink(long fileId,
                                int pageId)
                                  throws YfyException

List share links of a file

Parameters:

fileId - File id in fangcloud

pageId - Page id begin with 0

Returns:

All related share links' information

Throws:

YfyException

listShareLink

public ListShareLinkResult listShareLink(long fileId,
                                int pageId,
                                long ownerId)
                                  throws YfyException

List file's share links created by specific owner

Parameters:

fileId - File id in fangcloud

pageId - Page id begin with 0

ownerId - Owner id of share link you want to see

Returns:

All related share links' information

Throws:

YfyException

listComment

public ListCommentResult listComment(long fileId)
                              throws YfyException

List file's all comments' information

Parameters:

fileId - File id in fangcloud

Returns:

All file's comments' information

Throws:

YfyException