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 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Agent
getAgent()
Get 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.String
getChannelTemplateId()
Get 对应第三方应用平台企业的模板IDLong
getContentType()
Get 查询内容: 0-模板列表及详情(默认), 1-仅模板列表Long
getLimit()
Get 指定每页多少条数据,如果不传默认为20,单页最大100。Long
getOffset()
Get 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。UserInfo
getOperator()
Deprecated.Boolean
getQueryAllComponents()
Get 是否返回所有组件信息。 默认false,只返回发起方控件; true,返回所有签署方控件String
getTemplateId()
Get 模板唯一标识,查询单个模板时使用String
getTemplateName()
Get 模糊搜索模板名称,最大长度200Boolean
getWithPdfUrl()
Get 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。Boolean
getWithPreviewUrl()
Get 是否获取模板预览链接, 默认false-不获取 true-获取void
setAgent(Agent Agent)
Set 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.void
setChannelTemplateId(String ChannelTemplateId)
Set 对应第三方应用平台企业的模板IDvoid
setContentType(Long ContentType)
Set 查询内容: 0-模板列表及详情(默认), 1-仅模板列表void
setLimit(Long Limit)
Set 指定每页多少条数据,如果不传默认为20,单页最大100。void
setOffset(Long Offset)
Set 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。void
setOperator(UserInfo Operator)
Deprecated.void
setQueryAllComponents(Boolean QueryAllComponents)
Set 是否返回所有组件信息。 默认false,只返回发起方控件; true,返回所有签署方控件void
setTemplateId(String TemplateId)
Set 模板唯一标识,查询单个模板时使用void
setTemplateName(String TemplateName)
Set 模糊搜索模板名称,最大长度200void
setWithPdfUrl(Boolean WithPdfUrl)
Set 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。void
setWithPreviewUrl(Boolean WithPreviewUrl)
Set 是否获取模板预览链接, 默认false-不获取 true-获取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
-
-
-
-
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必填。- Returns:
- Agent 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
-
setAgent
public void setAgent(Agent Agent)
Set 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。- Parameters:
Agent
- 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
-
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开始,即首页为0。- Returns:
- Offset 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
-
setOffset
public void setOffset(Long Offset)
Set 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。- Parameters:
Offset
- 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为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
-
getWithPreviewUrl
public Boolean getWithPreviewUrl()
Get 是否获取模板预览链接, 默认false-不获取 true-获取- Returns:
- WithPreviewUrl 是否获取模板预览链接, 默认false-不获取 true-获取
-
setWithPreviewUrl
public void setWithPreviewUrl(Boolean WithPreviewUrl)
Set 是否获取模板预览链接, 默认false-不获取 true-获取- Parameters:
WithPreviewUrl
- 是否获取模板预览链接, 默认false-不获取 true-获取
-
getWithPdfUrl
public Boolean getWithPdfUrl()
Get 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。- Returns:
- WithPdfUrl 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。
-
setWithPdfUrl
public void setWithPdfUrl(Boolean WithPdfUrl)
Set 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。- Parameters:
WithPdfUrl
- 是否获取模板的PDF文件链接。 默认false-不获取 true-获取 请联系客户经理开白后使用。
-
getChannelTemplateId
public String getChannelTemplateId()
Get 对应第三方应用平台企业的模板ID- Returns:
- ChannelTemplateId 对应第三方应用平台企业的模板ID
-
setChannelTemplateId
public void setChannelTemplateId(String ChannelTemplateId)
Set 对应第三方应用平台企业的模板ID- Parameters:
ChannelTemplateId
- 对应第三方应用平台企业的模板ID
-
getOperator
@Deprecated public UserInfo getOperator()
Deprecated.Get 操作者的信息- Returns:
- Operator 操作者的信息
-
setOperator
@Deprecated public void setOperator(UserInfo Operator)
Deprecated.Set 操作者的信息- Parameters:
Operator
- 操作者的信息
-
-