程序包 com.dss.sdk.api.client

类 FileTransferClient

java.lang.Object

com.dss.sdk.api.base.BaseApi

com.dss.sdk.api.client.FileTransferClient

public class FileTransferClient
extends BaseApi

作者:

Fadada

字段概要

从类继承的字段 com.dss.sdk.api.base.BaseApi

clientService

构造器概要

构造器

构造器	说明
FileTransferClient(DssClientService clientService)

方法概要

修饰符和类型	方法	说明
DssResponse<FileDeleteResponse>	deleteFile(FileDeleteRequest fileDeleteRequest)	POST /api/file/delete : 文件删除
DssResponse<DssEntityResponse>	downloadStream(FileDownloadRequest fileDownloadRequest)
DssResponse<FileGetFileInfoResponse>	filePreUpload(FileUploadRequest fileUploadRequest)	POST /filePre/api/upload : 文件上传（含文件转换）
DssResponse<FileGetFileInfoResponse>	getFileInfo(FileGetFileInfoRequest fileGetFileInfoRequest)	POST /api/file/info : 查询文件信息 接口说明：提供通过“文件上传”接口返回的原文件id，可查询该文件转换后的pdf或ofd文件id 适用场景：针文件上传相关接口pdf或ofd转换结果查询。
DssResponse<FileRegisterResponse>	prepareFile(FileRegisterRequest fileUploadRequest)	POST /api/file/register : 文件注册 接口说明：提供文件id，可将普通文件注册到，签署文件存储系统，用于签署。

从类继承的方法 java.lang.Object

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

构造器详细资料

FileTransferClient

public FileTransferClient(DssClientService clientService)

方法详细资料

filePreUpload

public DssResponse<FileGetFileInfoResponse> filePreUpload(FileUploadRequest fileUploadRequest)
                                                   throws ApiException

POST /filePre/api/upload : 文件上传（含文件转换）

参数:

fileUploadRequest -

返回:

成功 (status code 200)

抛出:

ApiException

downloadStream

public DssResponse<DssEntityResponse> downloadStream(FileDownloadRequest fileDownloadRequest)
                                              throws ApiException

抛出:

ApiException

getFileInfo

public DssResponse<FileGetFileInfoResponse> getFileInfo(FileGetFileInfoRequest fileGetFileInfoRequest)
                                                 throws ApiException

POST /api/file/info : 查询文件信息 接口说明：提供通过“文件上传”接口返回的原文件id，可查询该文件转换后的pdf或ofd文件id 适用场景：针文件上传相关接口pdf或ofd转换结果查询。

参数:

fileGetFileInfoRequest - (optional)

返回:

成功 (status code 200)

抛出:

ApiException

prepareFile

public DssResponse<FileRegisterResponse> prepareFile(FileRegisterRequest fileUploadRequest)
                                              throws ApiException

POST /api/file/register : 文件注册 接口说明：提供文件id，可将普通文件注册到，签署文件存储系统，用于签署。

参数:

fileUploadRequest - (optional)

返回:

成功 (status code 200)

抛出:

ApiException

deleteFile

public DssResponse<FileDeleteResponse> deleteFile(FileDeleteRequest fileDeleteRequest)
                                           throws ApiException

POST /api/file/delete : 文件删除

参数:

fileDeleteRequest - 文件删除请求

返回:

文件删除响应

抛出:

ApiException - API异常