com.tencent.cos.xml.model.ci

类 PreviewDocumentRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

com.tencent.cos.xml.model.object.ObjectRequest

com.tencent.cos.xml.model.object.GetObjectRequest

com.tencent.cos.xml.model.ci.PreviewDocumentRequest

public class PreviewDocumentRequest
extends GetObjectRequest

预览文档的请求.

另请参阅:

CosXmlService.previewDocument(PreviewDocumentRequest), CosXmlService.previewDocumentAsync(PreviewDocumentRequest, CosXmlResultListener)

嵌套类概要

从类继承的嵌套类/接口 com.tencent.cos.xml.model.CosXmlRequest

CosXmlRequest.OnRequestWeightListener

字段概要

从类继承的字段 com.tencent.cos.xml.model.object.ObjectRequest

cosPath

从类继承的字段 com.tencent.cos.xml.model.CosXmlRequest

bucket, noSignHeaders, noSignParams, priority, qCloudTaskStateListener, queryParameters, region, requestHeaders, requestURL, signSourceProvider

构造器概要

构造器

构造器和说明
PreviewDocumentRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String savePath, int page) 预览请求构造器
PreviewDocumentRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String savePath, java.lang.String fileName, int page) 预览请求构造器

方法概要

限定符和类型	方法和说明
void	checkParameters() sdk 参数校验
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
PreviewDocumentRequest	setComment(int comment) 是否隐藏批注和应用修订，默认为 0 0：隐藏批注，应用修订 1：显示批注和修订
PreviewDocumentRequest	setDstType(java.lang.String dstType) 转换输出目标文件类型： png，转成 png 格式的图片文件 jpg，转成 jpg 格式的图片文件 pdf，转成 pdf 格式的图片文件。
PreviewDocumentRequest	setExcelCol(int excelCol) 值为1表示将所有行放到 1 页进行排版，默认值为 0
PreviewDocumentRequest	setExcelPaperDirection(int excelPaperDirection) 表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0
PreviewDocumentRequest	setExcelPaperSize(int excelPaperSize) 设置纸张（画布）大小，对应信息为： 0 → A4 、 1 → A2 、 2 → A0 ，默认 A4 纸张 （需配合 excelRow 或 excelCol 一起使用）
PreviewDocumentRequest	setExcelRow(int excelRow) 值为1表示将所有列放到 1 页进行排版，默认值为 0
PreviewDocumentRequest	setExcelSheet(int sheet) 表格文件参数，转换第 X 个表，默认为1
PreviewDocumentRequest	setImageDpi(int imageDpi) 按指定 dpi 渲染图片，该参数与 scale 共同作用，取值范围 96-600 ，默认值为 96 。
PreviewDocumentRequest	setImageParams(java.lang.String imageParams) 转换后的图片处理参数，支持 基础图片处理 所有处理参数，多个处理参数可通过 管道操作符 分隔，从而实现在一次访问中按顺序对图片进行不同处理
PreviewDocumentRequest	setPassword(java.lang.String password) Office 文档的打开密码，如果需要转换有密码的文档，请设置该字段
PreviewDocumentRequest	setQuality(int quality) 生成预览图的图片质量，取值范围为 [1, 100]，默认值100。
PreviewDocumentRequest	setScale(int scale) 预览图片的缩放参数，取值范围为 [10, 200]， 默认值100。
PreviewDocumentRequest	setSrcType(java.lang.String srcType) 非必选字段，当前文档转换根据 COS 对象的后缀名来确定源数据类型。
PreviewDocumentRequest	setTxtPagination(boolean txtPagination) 是否转换成长文本，设置为 true 时，可以将需要导出的页中的文字合并导出，分页范围可以通过 Ranges 控制。

从类继承的方法 com.tencent.cos.xml.model.object.GetObjectRequest

getDownloadPath, getFileContentUri, getFileOffset, getProgressListener, getQueryString, getRange, getRspCacheControl, getRspContentDispositon, getRspContentEncoding, getRspContentLanguage, getRspContentType, getRspExpires, getSaveFileName, getSavePath, setFileOffset, setIfMatch, setIfModifiedSince, setIfNONEMatch, setIfUnmodifiedSince, setProgressListener, setRange, setRange, setRspCacheControl, setRspContentDispositon, setRspContentEncoding, setRspContentLanguage, setRspContentType, setRspExpires, setSaveFileName, setSavePath, setTrafficLimit, setVersionId, xmlBuilder

从类继承的方法 com.tencent.cos.xml.model.object.ObjectRequest

getContentType, getCosPath, getPath, setCosPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS

从类继承的方法 com.tencent.cos.xml.model.CosXmlRequest

addHeader, addNoSignHeader, addNoSignParams, addQuery, attachMetrics, getBucket, getHttpTask, getKeyTime, getMetrics, getNoSignHeaders, getNoSignParams, getPriority, getQueryEncodedString, getRegion, getRequestBody, getRequestHeaders, getRequestHost, getRequestURL, getSignSourceProvider, getSTSCredentialScope, getWeight, headersHasUnsafeNonAscii, isNeedMD5, isSignInUrl, isSupportAccelerate, isSupportAccelerate, setNeedMD5, setOnRequestWeightListener, setQueryEncodedString, setQueryParameters, setRegion, setRequestHeaders, setRequestHeaders, setRequestHeaders, setRequestURL, setSign, setSign, setSign, setSign, setSign, setSignInUrl, setSignKeyTime, setSignParamsAndHeaders, setSignSourceProvider, setTask, setTaskStateListener

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

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

构造器详细资料

PreviewDocumentRequest

public PreviewDocumentRequest(java.lang.String bucket,
                              java.lang.String cosPath,
                              java.lang.String savePath,
                              int page)

预览请求构造器

参数:

bucket - 文档所在存储桶

cosPath - 文档的对象键

savePath - 文档本地保存路径

page - 需转换的文档页码，从 1 开始

PreviewDocumentRequest

public PreviewDocumentRequest(java.lang.String bucket,
                              java.lang.String cosPath,
                              java.lang.String savePath,
                              java.lang.String fileName,
                              int page)

预览请求构造器

参数:

bucket - 文档所在存储桶

cosPath - 文档的对象键

savePath - 文档本地保存路径

fileName - 本地文件名称

page - 需转换的文档页码，从 1 开始

方法详细资料

setSrcType

public PreviewDocumentRequest setSrcType(java.lang.String srcType)

非必选字段，当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时，可以设置该值。

参数:

srcType - 源数据的后缀类型

setDstType

public PreviewDocumentRequest setDstType(java.lang.String dstType)

转换输出目标文件类型： png，转成 png 格式的图片文件 jpg，转成 jpg 格式的图片文件 pdf，转成 pdf 格式的图片文件。无法选择页码，page 参数不生效 txt，转成 txt 格式文件 如果传入的格式未能识别，默认使用 jpg 格式

参数:

dstType - 输出目标文件类型

setPassword

public PreviewDocumentRequest setPassword(java.lang.String password)

Office 文档的打开密码，如果需要转换有密码的文档，请设置该字段

参数:

password - Office 文档的打开密码

setComment

public PreviewDocumentRequest setComment(int comment)

是否隐藏批注和应用修订，默认为 0 0：隐藏批注，应用修订 1：显示批注和修订

参数:

comment - 是否隐藏批注和应用修订

setExcelSheet

public PreviewDocumentRequest setExcelSheet(int sheet)

表格文件参数，转换第 X 个表，默认为1

参数:

sheet - 表格文件参数，转换第 X 个表

setExcelPaperDirection

public PreviewDocumentRequest setExcelPaperDirection(int excelPaperDirection)

表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0

参数:

excelPaperDirection - 表格文件转换纸张方向

setExcelRow

public PreviewDocumentRequest setExcelRow(int excelRow)

值为1表示将所有列放到 1 页进行排版，默认值为 0

参数:

excelRow - 值为1表示将所有列放到 1 页进行排版，默认值为 0

setExcelCol

public PreviewDocumentRequest setExcelCol(int excelCol)

值为1表示将所有行放到 1 页进行排版，默认值为 0

参数:

excelCol - 值为1表示将所有行放到 1 页进行排版，默认值为 0

setExcelPaperSize

public PreviewDocumentRequest setExcelPaperSize(int excelPaperSize)

设置纸张（画布）大小，对应信息为： 0 → A4 、 1 → A2 、 2 → A0 ，默认 A4 纸张 （需配合 excelRow 或 excelCol 一起使用）

参数:

excelPaperSize - 纸张（画布）大小

setTxtPagination

public PreviewDocumentRequest setTxtPagination(boolean txtPagination)

是否转换成长文本，设置为 true 时，可以将需要导出的页中的文字合并导出，分页范围可以通过 Ranges 控制。默认值为 false ，按页导出 txt。（ dstType="txt" 时生效)

参数:

txtPagination - 是否转换成长文本

setImageParams

public PreviewDocumentRequest setImageParams(java.lang.String imageParams)

转换后的图片处理参数，支持 基础图片处理 所有处理参数，多个处理参数可通过 管道操作符 分隔，从而实现在一次访问中按顺序对图片进行不同处理

参数:

imageParams - 图片处理参数

setQuality

public PreviewDocumentRequest setQuality(int quality)

生成预览图的图片质量，取值范围为 [1, 100]，默认值100。 例如取值为100，代表生成图片质量为100%

参数:

quality - 生成预览图的图片质量

setScale

public PreviewDocumentRequest setScale(int scale)

预览图片的缩放参数，取值范围为 [10, 200]， 默认值100。 例如取值为200，代表图片缩放比例为200% 即放大两倍

参数:

scale - 预览图片的缩放参数

setImageDpi

public PreviewDocumentRequest setImageDpi(int imageDpi)

按指定 dpi 渲染图片，该参数与 scale 共同作用，取值范围 96-600 ，默认值为 96 。转码后的图片单边宽度需小于65500像素

参数:

imageDpi - 按指定 dpi 渲染图片

checkParameters

public void checkParameters()
                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

sdk 参数校验

覆盖:

checkParameters 在类中 ObjectRequest

抛出:

CosXmlClientException - cosXmlClientException

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

覆盖:

getMethod 在类中 GetObjectRequest

返回:

HTTP请求方法