com.tencentcloudapi.ess.v20201111.models

Class CreateDocumentRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateDocumentRequest

public class CreateDocumentRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateDocumentRequest()
CreateDocumentRequest(CreateDocumentRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Agent	getAgent() Get 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
String	getClientToken() Get 客户端Token，保持接口幂等性,最大长度64个字符
String[]	getFileNames() Get 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起
String	getFlowId() Get 签署流程编号,由CreateFlow接口返回
FormField[]	getFormFields() Get 内容控件信息数组
Boolean	getNeedPreview() Get 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；
UserInfo	getOperator() Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
Long	getPreviewType() Get 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
String	getTemplateId() Get 用户上传的模板ID
void	setAgent(Agent Agent) Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
void	setClientToken(String ClientToken) Set 客户端Token，保持接口幂等性,最大长度64个字符
void	setFileNames(String[] FileNames) Set 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起
void	setFlowId(String FlowId) Set 签署流程编号,由CreateFlow接口返回
void	setFormFields(FormField[] FormFields) Set 内容控件信息数组
void	setNeedPreview(Boolean NeedPreview) Set 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；
void	setOperator(UserInfo Operator) Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
void	setPreviewType(Long PreviewType) Set 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
void	setTemplateId(String TemplateId) Set 用户上传的模板ID
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDocumentRequest

public CreateDocumentRequest()

CreateDocumentRequest

public CreateDocumentRequest(CreateDocumentRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getOperator

public UserInfo getOperator()

Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

Returns:

Operator 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

setOperator

public void setOperator(UserInfo Operator)

Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

Parameters:

Operator - 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

getFlowId

public String getFlowId()

Get 签署流程编号,由CreateFlow接口返回

Returns:

FlowId 签署流程编号,由CreateFlow接口返回

setFlowId

public void setFlowId(String FlowId)

Set 签署流程编号,由CreateFlow接口返回

Parameters:

FlowId - 签署流程编号,由CreateFlow接口返回

getTemplateId

public String getTemplateId()

Get 用户上传的模板ID

Returns:

TemplateId 用户上传的模板ID

setTemplateId

public void setTemplateId(String TemplateId)

Set 用户上传的模板ID

Parameters:

TemplateId - 用户上传的模板ID

getFileNames

public String[] getFileNames()

Get 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起

Returns:

FileNames 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起

setFileNames

public void setFileNames(String[] FileNames)

Set 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起

Parameters:

FileNames - 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起

getFormFields

public FormField[] getFormFields()

Get 内容控件信息数组

Returns:

FormFields 内容控件信息数组

setFormFields

public void setFormFields(FormField[] FormFields)

Set 内容控件信息数组

Parameters:

FormFields - 内容控件信息数组

getNeedPreview

public Boolean getNeedPreview()

Get 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；

Returns:

NeedPreview 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；

setNeedPreview

public void setNeedPreview(Boolean NeedPreview)

Set 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；

Parameters:

NeedPreview - 是否需要生成预览文件 默认不生成； 预览链接有效期300秒；

getPreviewType

public Long getPreviewType()

Get 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,

Returns:

PreviewType 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,

setPreviewType

public void setPreviewType(Long PreviewType)

Set 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,

Parameters:

PreviewType - 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,

getAgent

public Agent getAgent()

Get 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Returns:

Agent 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

setAgent

public void setAgent(Agent Agent)

Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Parameters:

Agent - 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

getClientToken

public String getClientToken()

Get 客户端Token，保持接口幂等性,最大长度64个字符

Returns:

ClientToken 客户端Token，保持接口幂等性,最大长度64个字符

setClientToken

public void setClientToken(String ClientToken)

Set 客户端Token，保持接口幂等性,最大长度64个字符

Parameters:

ClientToken - 客户端Token，保持接口幂等性,最大长度64个字符

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel