com.herewhite.sdk.converter.ConverterV5.Builder class 参考

  • Android

更新时间

详细描述

适用版本:Whiteboard Android SDK 2.16.134。

属性与 JSON 字段

Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。

字段声明源码初值说明
resourceString resource未显式赋值

模型属性;通过对应 getter/setter 访问。

typeConvertType type未显式赋值

模型属性;通过对应 getter/setter 访问。

previewboolean previewfalse

模型属性;通过对应 getter/setter 访问。

scaledouble scale1.2

静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。

outputFormatImageFormat outputFormat未显式赋值

模型属性;通过对应 getter/setter 访问。

packboolean packfalse

模型属性;通过对应 getter/setter 访问。

regionRegion region未显式赋值

模型属性;通过对应 getter/setter 访问。

sdkTokenString sdkToken未显式赋值

模型属性;通过对应 getter/setter 访问。

taskUuidString taskUuid未显式赋值

模型属性;通过对应 getter/setter 访问。

taskTokenString taskToken未显式赋值

模型属性;通过对应 getter/setter 访问。

timeoutlong timeout未显式赋值

模型属性;通过对应 getter/setter 访问。

callbackConverterCallbacks callback未显式赋值

模型属性;通过对应 getter/setter 访问。

表格内容超出当前宽度,可横向滚动查看更多列。
公开成员签名
BuildersetResource (String resource)
BuildersetType (ConvertType type)
BuildersetPreview (boolean preview)
BuildersetScale (double scale)
BuildersetOutputFormat (ImageFormat outputFormat)
BuildersetPack (boolean pack)
BuildersetRegion (Region region)
BuildersetSdkToken (String sdkToken)
BuildersetTaskUuid (String taskUuid)
BuildersetTaskToken (String taskToken)
BuildersetPoolInterval (long interval)
BuildersetTimeout (long timeout)
BuildersetCallback (ConverterCallbacks callback)
ConverterV5build ()
表格内容超出当前宽度,可横向滚动查看更多列。

变量说明

resource

Text
String resource

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

type

Text
ConvertType type

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

preview

Text
boolean preview

源码初值:false

模型属性;通过对应 getter/setter 访问。

scale

Text
double scale

源码初值:1.2

静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。

outputFormat

Text
ImageFormat outputFormat

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

pack

Text
boolean pack

源码初值:false

模型属性;通过对应 getter/setter 访问。

region

Text
Region region

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

sdkToken

Text
String sdkToken

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

taskUuid

Text
String taskUuid

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

taskToken

Text
String taskToken

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

timeout

Text
long timeout

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

callback

Text
ConverterCallbacks callback

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

函数说明

setResource()

Builder setResource(String resource)

参数

参数
参数名描述
resource

转换任务源文件 url

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setType()

Builder setType(ConvertType type)

参数

参数
参数名描述
type

转换任务类型,枚举:dynamic, static

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setPreview()

Builder setPreview(boolean preview)

只有动态文档转换支持预览图功能,同时生成预览图需要消耗较长时间,请根据业务需要选择

参数

参数
参数名描述
preview

是否需要生成预览图,默认为 false

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setScale()

Builder setScale(double scale)

静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。

setOutputFormat()

Builder setOutputFormat(ImageFormat outputFormat)

只有静态文档转换支持自定义输出格式

参数

参数
参数名描述
outputFormat

输出图片格式,默认为 png,可选参数为 png/jpg/jpeg/webp

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setPack()

Builder setPack(boolean pack)

只有静态文档转换支持 pack 参数

参数

参数
参数名描述
pack

是否要生成资源包

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setRegion()

Builder setRegion(Region region)

参数

参数
参数名描述
region

数据中心 ID(不填则为 cn-hz)

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setSdkToken()

Builder setSdkToken(String sdkToken)

参数

参数
参数名描述
sdkToken

用于发起文档转换任务并得到 taskuuid

表格内容超出当前宽度,可横向滚动查看更多列。

注意

由于 sdktoken 的权限过大,我们不建议将 sdktoken 暴露到前端,建议使用 sdktoken 签出 tasktoken,将 tasktoken 传到前端使用,只有拥有 tasktoken 的用户才能查询对应的任务进度。

返回值

当前 Builder 实例,可继续链式配置。

setTaskUuid()

Builder setTaskUuid(String taskUuid)

参数

参数
参数名描述
taskUuid

任务唯一标识

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setTaskToken()

Builder setTaskToken(String taskToken)

参数

参数
参数名描述
taskToken

任务查询token

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

当前 Builder 实例,可继续链式配置。

setPoolInterval()

Builder setPoolInterval(long interval)

setPoolInterval:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。

setTimeout()

Builder setTimeout(long timeout)

setTimeout:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。

setCallback()

Builder setCallback(ConverterCallbacks callback)

setCallback:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。

build()

ConverterV5 build()

build:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。

这个页面有帮助吗?