com.tencent.cos.xml.model.ci

类 PreviewDocumentInHtmlRequest

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.PreviewDocumentInHtmlRequest

public class PreviewDocumentInHtmlRequest
extends GetObjectRequest

以HTML格式预览文档的请求.

另请参阅:

CosXmlService.previewDocumentInHtml(PreviewDocumentInHtmlRequest), CosXmlService.previewDocumentInHtmlAsync(PreviewDocumentInHtmlRequest, 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

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
PreviewDocumentInHtmlRequest	setCopyable(boolean copyable) 是否可复制（默认为可复制） 非必选字段
PreviewDocumentInHtmlRequest	setHtmlParams(java.lang.String htmlParams) 自定义配置参数，JSON 结构，需要经过 URL 安全 的 Base64 编码，默认配置为：{ commonOptions: { isShowTopArea: true, isShowHeader: true } } 支持的配置参考 自定义配置项说明
PreviewDocumentInHtmlRequest	setSrcType(java.lang.String srcType) 指定目标文件类型，支持的文件类型请见下方 目前支持的输入文件类型包含如下格式： 演示文件：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm。
PreviewDocumentInHtmlRequest	setWatermark(java.lang.String watermark) 水印文字，需要经过 URL 安全 的 Base64 编码，默认为空 非必选字段
PreviewDocumentInHtmlRequest	setWatermarkColor(java.lang.String htmlfillstyle) 水印 RGBA（颜色和透明度），默认为：rgba(192,192,192,0.6) 非必选字段
PreviewDocumentInHtmlRequest	setWatermarkFont(java.lang.String font) 水印文字样式，默认为：bold 20px Serif 非必选字段
PreviewDocumentInHtmlRequest	setWatermarkHorizontal(int horizontal) 水印文字水平间距，单位 px，默认为50 非必选字段
PreviewDocumentInHtmlRequest	setWatermarkRotate(int rotate) 旋转角度，0~360，默认315度 非必选字段
PreviewDocumentInHtmlRequest	setWatermarkVertical(int vertical) 水印文字垂直间距，单位 px，默认为100 非必选字段

从类继承的方法 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

checkParameters, 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

构造器详细资料

PreviewDocumentInHtmlRequest

public PreviewDocumentInHtmlRequest(java.lang.String bucket,
                                    java.lang.String cosPath,
                                    java.lang.String savePath)

预览请求构造器

参数:

bucket - 文档所在存储桶

cosPath - 文档的对象键

savePath - 文档本地保存路径

PreviewDocumentInHtmlRequest

public PreviewDocumentInHtmlRequest(java.lang.String bucket,
                                    java.lang.String cosPath,
                                    java.lang.String savePath,
                                    java.lang.String fileName)

预览请求构造器

参数:

bucket - 文档所在存储桶

cosPath - 文档的对象键

savePath - 文档本地保存路径

fileName - 本地文件名称

方法详细资料

setSrcType

public PreviewDocumentInHtmlRequest setSrcType(java.lang.String srcType)

指定目标文件类型，支持的文件类型请见下方 目前支持的输入文件类型包含如下格式： 演示文件：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm。 文字文件：doc、dot、wps、wpt、docx、dotx、docm、dotm。 表格文件：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。 其他格式文件： pdf、 lrc、 c、 cpp、 h、 asm、 s、 java、 asp、 bat、 bas、 prg、 cmd、 rtf、 txt、 log、 xml、 htm、 html。 输入文件大小限制在200MB之内。 输入文件页数限制在5000页之内。

参数:

srcType - 指定目标文件类型

setCopyable

public PreviewDocumentInHtmlRequest setCopyable(boolean copyable)

是否可复制（默认为可复制） 非必选字段

参数:

copyable - 是否可复制

setHtmlParams

public PreviewDocumentInHtmlRequest setHtmlParams(java.lang.String htmlParams)

自定义配置参数，JSON 结构，需要经过 URL 安全 的 Base64 编码，默认配置为：{ commonOptions: { isShowTopArea: true, isShowHeader: true } } 支持的配置参考 自定义配置项说明

参数:

htmlParams - 自定义配置参数

setWatermark

public PreviewDocumentInHtmlRequest setWatermark(java.lang.String watermark)

水印文字，需要经过 URL 安全 的 Base64 编码，默认为空 非必选字段

参数:

watermark - 水印文字

setWatermarkColor

public PreviewDocumentInHtmlRequest setWatermarkColor(java.lang.String htmlfillstyle)

水印 RGBA（颜色和透明度），默认为：rgba(192,192,192,0.6) 非必选字段

参数:

htmlfillstyle - 水印 RGBA（颜色和透明度）

setWatermarkFont

public PreviewDocumentInHtmlRequest setWatermarkFont(java.lang.String font)

水印文字样式，默认为：bold 20px Serif 非必选字段

参数:

font - 水印文字样式

setWatermarkRotate

public PreviewDocumentInHtmlRequest setWatermarkRotate(int rotate)

旋转角度，0~360，默认315度 非必选字段

参数:

rotate - 旋转角度

setWatermarkHorizontal

public PreviewDocumentInHtmlRequest setWatermarkHorizontal(int horizontal)

水印文字水平间距，单位 px，默认为50 非必选字段

参数:

horizontal - 水印文字水平间距

setWatermarkVertical

public PreviewDocumentInHtmlRequest setWatermarkVertical(int vertical)

水印文字垂直间距，单位 px，默认为100 非必选字段

参数:

vertical - 水印文字垂直间距

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

覆盖:

getMethod 在类中 GetObjectRequest

返回:

HTTP请求方法