com.tencent.cos.xml.model.ci

类 PreviewDocumentInHtmlBytesRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

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

com.tencent.cos.xml.model.ci.PreviewDocumentInHtmlBytesRequest

直接已知子类:

PreviewDocumentInHtmlLinkRequest

public class PreviewDocumentInHtmlBytesRequest
extends ObjectRequest

以HTML格式直出内容预览文档的请求.

另请参阅:

CosXmlService.previewDocumentInHtmlBytes(String, String)

嵌套类概要

从类继承的嵌套类/接口 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

构造器概要

构造器

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

方法概要

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

从类继承的方法 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, getQueryString, getRegion, 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, xmlBuilder

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

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

构造器详细资料

PreviewDocumentInHtmlBytesRequest

public PreviewDocumentInHtmlBytesRequest(java.lang.String bucket,
                                         java.lang.String cosPath)

预览请求构造器

参数:

bucket - 文档所在存储桶

cosPath - 文档的对象键

方法详细资料

setSrcType

public PreviewDocumentInHtmlBytesRequest 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 PreviewDocumentInHtmlBytesRequest setCopyable(boolean copyable)

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

参数:

copyable - 是否可复制

setHtmlParams

public PreviewDocumentInHtmlBytesRequest setHtmlParams(java.lang.String htmlParams)

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

参数:

htmlParams - 自定义配置参数

setWatermark

public PreviewDocumentInHtmlBytesRequest setWatermark(java.lang.String watermark)

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

参数:

watermark - 水印文字

setWatermarkColor

public PreviewDocumentInHtmlBytesRequest setWatermarkColor(java.lang.String htmlfillstyle)

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

参数:

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

setWatermarkFont

public PreviewDocumentInHtmlBytesRequest setWatermarkFont(java.lang.String font)

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

参数:

font - 水印文字样式

setWatermarkRotate

public PreviewDocumentInHtmlBytesRequest setWatermarkRotate(int rotate)

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

参数:

rotate - 旋转角度

setWatermarkHorizontal

public PreviewDocumentInHtmlBytesRequest setWatermarkHorizontal(int horizontal)

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

参数:

horizontal - 水印文字水平间距

setWatermarkVertical

public PreviewDocumentInHtmlBytesRequest setWatermarkVertical(int vertical)

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

参数:

vertical - 水印文字垂直间距

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

getRequestBody

public RequestBodySerializer getRequestBody()
                                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

获取请求体

覆盖:

getRequestBody 在类中 CosXmlRequest

返回:

请求体

抛出:

CosXmlClientException - 客户异常