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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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（子企业的组织ID）为必填项。
String	getClientToken() Get 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
String[]	getFileNames() Get 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
String	getFlowId() Get 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。
FormField[]	getFormFields() Get 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。
Boolean	getNeedPreview() Get 是否为预览模式，取值如下： **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。 **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
UserInfo	getOperator() Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
Long	getPreviewType() Get 预览模式下产生的预览链接类型 **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 **1** :H5链接 ,点开后在浏览器中展示合同的样子 注: `此参数在NeedPreview 为true时有效`
String	getTemplateId() Get 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setClientToken(String ClientToken) Set 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
void	setFileNames(String[] FileNames) Set 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
void	setFlowId(String FlowId) Set 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。
void	setFormFields(FormField[] FormFields) Set 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。
void	setNeedPreview(Boolean NeedPreview) Set 是否为预览模式，取值如下： **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。 **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
void	setOperator(UserInfo Operator) Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
void	setPreviewType(Long PreviewType) Set 预览模式下产生的预览链接类型 **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 **1** :H5链接 ,点开后在浏览器中展示合同的样子 注: `此参数在NeedPreview 为true时有效`
void	setTemplateId(String TemplateId) Set 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, 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 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。

Returns:

FlowId 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。

setFlowId

public void setFlowId(String FlowId)

Set 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。

Parameters:

FlowId - 合同流程ID，为32位字符串。 此接口的合同流程ID需要由创建签署流程接口创建得到。

getTemplateId

public String getTemplateId()

Get 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。

Returns:

TemplateId 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。

setTemplateId

public void setTemplateId(String TemplateId)

Set 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。

Parameters:

TemplateId - 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的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 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

Returns:

FormFields 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

setFormFields

public void setFormFields(FormField[] FormFields)

Set 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

Parameters:

FormFields - 电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

getNeedPreview

public Boolean getNeedPreview()

Get 是否为预览模式，取值如下：

• **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
• **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

Returns:

NeedPreview 是否为预览模式，取值如下：

• **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
• **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

setNeedPreview

public void setNeedPreview(Boolean NeedPreview)

Set 是否为预览模式，取值如下：

• **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
• **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

Parameters:

NeedPreview - 是否为预览模式，取值如下：

• **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
• **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

getPreviewType

public Long getPreviewType()

Get 预览模式下产生的预览链接类型

• **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件
• **1** :H5链接 ,点开后在浏览器中展示合同的样子

注: `此参数在NeedPreview 为true时有效`

Returns:

PreviewType 预览模式下产生的预览链接类型

• **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件
• **1** :H5链接 ,点开后在浏览器中展示合同的样子

注: `此参数在NeedPreview 为true时有效`

setPreviewType

public void setPreviewType(Long PreviewType)

Set 预览模式下产生的预览链接类型

• **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件
• **1** :H5链接 ,点开后在浏览器中展示合同的样子

注: `此参数在NeedPreview 为true时有效`

Parameters:

PreviewType - 预览模式下产生的预览链接类型

• **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件
• **1** :H5链接 ,点开后在浏览器中展示合同的样子

注: `此参数在NeedPreview 为true时有效`

getAgent

public Agent getAgent()

Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Returns:

Agent 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

setAgent

public void setAgent(Agent Agent)

Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

Agent - 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

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