com.tencentcloudapi.essbasic.v20210526.models

Class DescribeTemplatesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.DescribeTemplatesRequest

public class DescribeTemplatesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeTemplatesRequest()
DescribeTemplatesRequest(DescribeTemplatesRequest 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 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
String	getChannelTemplateId() Get 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
Long	getContentType() Get 查询模板的内容 **0**：（默认）模板列表及详情 **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息
Long	getLimit() Get 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`
Long	getOffset() Get 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
UserInfo	getOperator() Deprecated.
Boolean	getQueryAllComponents() Get 返回控件的范围, 是只返回发起方自己的还是所有参与方的 **false**：（默认）只返回发起方控件 **true**：返回所有参与方(包括发起方和签署方)控件
String	getTemplateId() Get 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
String[]	getTemplateIds() Get 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2.
String	getTemplateName() Get 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
String	getUserFlowTypeId() Get 用户合同类型id
Boolean	getWithPdfUrl() Get 是否获取模板的PDF文件链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`
Boolean	getWithPreviewUrl() Get 是否获取模板预览链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
void	setAgent(Agent Agent) Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
void	setChannelTemplateId(String ChannelTemplateId) Set 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
void	setContentType(Long ContentType) Set 查询模板的内容 **0**：（默认）模板列表及详情 **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息
void	setLimit(Long Limit) Set 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`
void	setOffset(Long Offset) Set 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
void	setOperator(UserInfo Operator) Deprecated.
void	setQueryAllComponents(Boolean QueryAllComponents) Set 返回控件的范围, 是只返回发起方自己的还是所有参与方的 **false**：（默认）只返回发起方控件 **true**：返回所有参与方(包括发起方和签署方)控件
void	setTemplateId(String TemplateId) Set 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
void	setTemplateIds(String[] TemplateIds) Set 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2.
void	setTemplateName(String TemplateName) Set 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
void	setUserFlowTypeId(String UserFlowTypeId) Set 用户合同类型id
void	setWithPdfUrl(Boolean WithPdfUrl) Set 是否获取模板的PDF文件链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`
void	setWithPreviewUrl(Boolean WithPreviewUrl) Set 是否获取模板预览链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
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, isStream, 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

DescribeTemplatesRequest

public DescribeTemplatesRequest()

DescribeTemplatesRequest

public DescribeTemplatesRequest(DescribeTemplatesRequest 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

getAgent

public Agent getAgent()

Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

Returns:

Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

setAgent

public void setAgent(Agent Agent)

Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

Parameters:

Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

getTemplateId

public String getTemplateId()

Get 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

Returns:

TemplateId 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

setTemplateId

public void setTemplateId(String TemplateId)

Set 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

Parameters:

TemplateId - 合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

getContentType

public Long getContentType()

Get 查询模板的内容

• **0**：（默认）模板列表及详情
• **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息

Returns:

ContentType 查询模板的内容

• **0**：（默认）模板列表及详情
• **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息

setContentType

public void setContentType(Long ContentType)

Set 查询模板的内容

• **0**：（默认）模板列表及详情
• **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息

Parameters:

ContentType - 查询模板的内容

• **0**：（默认）模板列表及详情
• **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息

getTemplateIds

public String[] getTemplateIds()

Get 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。` 4. `若传递此参数，分页参数(Limit,Offset)无效` [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

Returns:

TemplateIds 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。` 4. `若传递此参数，分页参数(Limit,Offset)无效` [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

setTemplateIds

public void setTemplateIds(String[] TemplateIds)

Set 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。` 4. `若传递此参数，分页参数(Limit,Offset)无效` [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

Parameters:

TemplateIds - 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。` 4. `若传递此参数，分页参数(Limit,Offset)无效` [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)

getLimit

public Long getLimit()

Get 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`

Returns:

Limit 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`

setLimit

public void setLimit(Long Limit)

Set 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`

Parameters:

Limit - 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`

getOffset

public Long getOffset()

Get 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

Returns:

Offset 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

setOffset

public void setOffset(Long Offset)

Set 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

Parameters:

Offset - 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

getTemplateName

public String getTemplateName()

Get 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。

Returns:

TemplateName 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。

setTemplateName

public void setTemplateName(String TemplateName)

Set 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。

Parameters:

TemplateName - 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。

getChannelTemplateId

public String getChannelTemplateId()

Get 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。

Returns:

ChannelTemplateId 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。

setChannelTemplateId

public void setChannelTemplateId(String ChannelTemplateId)

Set 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。

Parameters:

ChannelTemplateId - 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。

getQueryAllComponents

public Boolean getQueryAllComponents()

Get 返回控件的范围, 是只返回发起方自己的还是所有参与方的

• **false**：（默认）只返回发起方控件
• **true**：返回所有参与方(包括发起方和签署方)控件

Returns:

QueryAllComponents 返回控件的范围, 是只返回发起方自己的还是所有参与方的

• **false**：（默认）只返回发起方控件
• **true**：返回所有参与方(包括发起方和签署方)控件

setQueryAllComponents

public void setQueryAllComponents(Boolean QueryAllComponents)

Set 返回控件的范围, 是只返回发起方自己的还是所有参与方的

• **false**：（默认）只返回发起方控件
• **true**：返回所有参与方(包括发起方和签署方)控件

Parameters:

QueryAllComponents - 返回控件的范围, 是只返回发起方自己的还是所有参与方的

• **false**：（默认）只返回发起方控件
• **true**：返回所有参与方(包括发起方和签署方)控件

getWithPreviewUrl

public Boolean getWithPreviewUrl()

Get 是否获取模板预览链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

Returns:

WithPreviewUrl 是否获取模板预览链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

setWithPreviewUrl

public void setWithPreviewUrl(Boolean WithPreviewUrl)

Set 是否获取模板预览链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

Parameters:

WithPreviewUrl - 是否获取模板预览链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

getWithPdfUrl

public Boolean getWithPdfUrl()

Get 是否获取模板的PDF文件链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`

Returns:

WithPdfUrl 是否获取模板的PDF文件链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`

setWithPdfUrl

public void setWithPdfUrl(Boolean WithPdfUrl)

Set 是否获取模板的PDF文件链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`

Parameters:

WithPdfUrl - 是否获取模板的PDF文件链接。

• **false**：不获取（默认）
• **true**：获取

设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`

getOperator

@Deprecated
public UserInfo getOperator()

Deprecated.

Get 操作者的信息

Returns:

Operator 操作者的信息

setOperator

@Deprecated
public void setOperator(UserInfo Operator)

Deprecated.

Set 操作者的信息

Parameters:

Operator - 操作者的信息

getUserFlowTypeId

public String getUserFlowTypeId()

Get 用户合同类型id

Returns:

UserFlowTypeId 用户合同类型id

setUserFlowTypeId

public void setUserFlowTypeId(String UserFlowTypeId)

Set 用户合同类型id

Parameters:

UserFlowTypeId - 用户合同类型id

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.