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

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.ProxyOrganizationOpenId、Agent.
Long	getContentType() Get 查询内容：0-模板列表及详情（默认），1-仅模板列表
Long	getLimit() Get 查询个数，默认20，最大100；在查询列表的时候有效
Long	getOffset() Get 查询偏移位置，默认0；在查询列表的时候有效
UserInfo	getOperator() Get 操作者的信息
Boolean	getQueryAllComponents() Get 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件
String	getTemplateId() Get 模板唯一标识，查询单个模板时使用
String	getTemplateName() Get 模糊搜索模板名称，最大长度200
Boolean	getWithPdfUrl() Get 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
Boolean	getWithPreviewUrl() Get 是否获取模板预览链接
void	setAgent(Agent Agent) Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.
void	setContentType(Long ContentType) Set 查询内容：0-模板列表及详情（默认），1-仅模板列表
void	setLimit(Long Limit) Set 查询个数，默认20，最大100；在查询列表的时候有效
void	setOffset(Long Offset) Set 查询偏移位置，默认0；在查询列表的时候有效
void	setOperator(UserInfo Operator) Set 操作者的信息
void	setQueryAllComponents(Boolean QueryAllComponents) Set 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件
void	setTemplateId(String TemplateId) Set 模板唯一标识，查询单个模板时使用
void	setTemplateName(String TemplateName) Set 模糊搜索模板名称，最大长度200
void	setWithPdfUrl(Boolean WithPdfUrl) Set 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
void	setWithPreviewUrl(Boolean WithPreviewUrl) Set 是否获取模板预览链接
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

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.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

Returns:

Agent 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

setAgent

public void setAgent(Agent Agent)

Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

Parameters:

Agent - 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

getTemplateId

public String getTemplateId()

Get 模板唯一标识，查询单个模板时使用

Returns:

TemplateId 模板唯一标识，查询单个模板时使用

setTemplateId

public void setTemplateId(String TemplateId)

Set 模板唯一标识，查询单个模板时使用

Parameters:

TemplateId - 模板唯一标识，查询单个模板时使用

getContentType

public Long getContentType()

Get 查询内容：0-模板列表及详情（默认），1-仅模板列表

Returns:

ContentType 查询内容：0-模板列表及详情（默认），1-仅模板列表

setContentType

public void setContentType(Long ContentType)

Set 查询内容：0-模板列表及详情（默认），1-仅模板列表

Parameters:

ContentType - 查询内容：0-模板列表及详情（默认），1-仅模板列表

getLimit

public Long getLimit()

Get 查询个数，默认20，最大100；在查询列表的时候有效

Returns:

Limit 查询个数，默认20，最大100；在查询列表的时候有效

setLimit

public void setLimit(Long Limit)

Set 查询个数，默认20，最大100；在查询列表的时候有效

Parameters:

Limit - 查询个数，默认20，最大100；在查询列表的时候有效

getOffset

public Long getOffset()

Get 查询偏移位置，默认0；在查询列表的时候有效

Returns:

Offset 查询偏移位置，默认0；在查询列表的时候有效

setOffset

public void setOffset(Long Offset)

Set 查询偏移位置，默认0；在查询列表的时候有效

Parameters:

Offset - 查询偏移位置，默认0；在查询列表的时候有效

getQueryAllComponents

public Boolean getQueryAllComponents()

Get 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件

Returns:

QueryAllComponents 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件

setQueryAllComponents

public void setQueryAllComponents(Boolean QueryAllComponents)

Set 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件

Parameters:

QueryAllComponents - 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件

getTemplateName

public String getTemplateName()

Get 模糊搜索模板名称，最大长度200

Returns:

TemplateName 模糊搜索模板名称，最大长度200

setTemplateName

public void setTemplateName(String TemplateName)

Set 模糊搜索模板名称，最大长度200

Parameters:

TemplateName - 模糊搜索模板名称，最大长度200

getOperator

public UserInfo getOperator()

Get 操作者的信息

Returns:

Operator 操作者的信息

setOperator

public void setOperator(UserInfo Operator)

Set 操作者的信息

Parameters:

Operator - 操作者的信息

getWithPreviewUrl

public Boolean getWithPreviewUrl()

Get 是否获取模板预览链接

Returns:

WithPreviewUrl 是否获取模板预览链接

setWithPreviewUrl

public void setWithPreviewUrl(Boolean WithPreviewUrl)

Set 是否获取模板预览链接

Parameters:

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

getWithPdfUrl

public Boolean getWithPdfUrl()

Get 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。

Returns:

WithPdfUrl 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。

setWithPdfUrl

public void setWithPdfUrl(Boolean WithPdfUrl)

Set 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。

Parameters:

WithPdfUrl - 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel