com.tencentcloudapi.ess.v20201111.models

Class TemplateInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.TemplateInfo

public class TemplateInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
TemplateInfo()
TemplateInfo(TemplateInfo 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
String[]	getAttachmentResourceIds() Get 附件关联的资源ID
Long	getAvailable() Get 模板可用状态： 1 启用（默认） 2 停用
Component[]	getComponents() Get 模板的填充控件列表
Long	getCreatedOn() Get 模板创建的时间戳，格式为Unix标准时间戳（秒）
String	getCreator() Get 模板的创建者信息，电子签系统用户ID
String	getDescription() Get 模板描述信息
String[]	getDocumentResourceIds() Get 模板关联的资源ID列表
FileInfo[]	getFileInfos() Get 生成模板的文件基础信息
String	getOrganizationId() Get 创建模板的企业ID，电子签的机构ID
String	getPreviewUrl() Get 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。
Recipient	getPromoter() Get 发起方参与信息Promoter
Boolean	getPublished() Get 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。
Recipient[]	getRecipients() Get 模板中的签署参与方列表
SealInfo[]	getSeals() Deprecated.
String	getShareTemplateId() Get 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。
Component[]	getSignComponents() Get 模板中的签署控件列表
Long[]	getSignOrder() Get 签署顺序 无序 -1 有序为序列数字 0,1,2
Long	getStatus() Get 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用
String	getTemplateId() Get 模板ID，模板的唯一标识
String	getTemplateName() Get 模板名
SealInfo[]	getTemplateSeals() Get 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。
Long	getTemplateType() Get 模板类型： 1 静默签, 3 普通模板
String	getTemplateVersion() Get 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。
void	setAttachmentResourceIds(String[] AttachmentResourceIds) Set 附件关联的资源ID
void	setAvailable(Long Available) Set 模板可用状态： 1 启用（默认） 2 停用
void	setComponents(Component[] Components) Set 模板的填充控件列表
void	setCreatedOn(Long CreatedOn) Set 模板创建的时间戳，格式为Unix标准时间戳（秒）
void	setCreator(String Creator) Set 模板的创建者信息，电子签系统用户ID
void	setDescription(String Description) Set 模板描述信息
void	setDocumentResourceIds(String[] DocumentResourceIds) Set 模板关联的资源ID列表
void	setFileInfos(FileInfo[] FileInfos) Set 生成模板的文件基础信息
void	setOrganizationId(String OrganizationId) Set 创建模板的企业ID，电子签的机构ID
void	setPreviewUrl(String PreviewUrl) Set 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。
void	setPromoter(Recipient Promoter) Set 发起方参与信息Promoter
void	setPublished(Boolean Published) Set 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。
void	setRecipients(Recipient[] Recipients) Set 模板中的签署参与方列表
void	setSeals(SealInfo[] Seals) Deprecated.
void	setShareTemplateId(String ShareTemplateId) Set 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。
void	setSignComponents(Component[] SignComponents) Set 模板中的签署控件列表
void	setSignOrder(Long[] SignOrder) Set 签署顺序 无序 -1 有序为序列数字 0,1,2
void	setStatus(Long Status) Set 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用
void	setTemplateId(String TemplateId) Set 模板ID，模板的唯一标识
void	setTemplateName(String TemplateName) Set 模板名
void	setTemplateSeals(SealInfo[] TemplateSeals) Set 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。
void	setTemplateType(Long TemplateType) Set 模板类型： 1 静默签, 3 普通模板
void	setTemplateVersion(String TemplateVersion) Set 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。
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

TemplateInfo

public TemplateInfo()

TemplateInfo

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

getTemplateId

public String getTemplateId()

Get 模板ID，模板的唯一标识

Returns:

TemplateId 模板ID，模板的唯一标识

setTemplateId

public void setTemplateId(String TemplateId)

Set 模板ID，模板的唯一标识

Parameters:

TemplateId - 模板ID，模板的唯一标识

getTemplateName

public String getTemplateName()

Get 模板名

Returns:

TemplateName 模板名

setTemplateName

public void setTemplateName(String TemplateName)

Set 模板名

Parameters:

TemplateName - 模板名

getDescription

public String getDescription()

Get 模板描述信息

Returns:

Description 模板描述信息

setDescription

public void setDescription(String Description)

Set 模板描述信息

Parameters:

Description - 模板描述信息

getDocumentResourceIds

public String[] getDocumentResourceIds()

Get 模板关联的资源ID列表

Returns:

DocumentResourceIds 模板关联的资源ID列表

setDocumentResourceIds

public void setDocumentResourceIds(String[] DocumentResourceIds)

Set 模板关联的资源ID列表

Parameters:

DocumentResourceIds - 模板关联的资源ID列表

getFileInfos

public FileInfo[] getFileInfos()

Get 生成模板的文件基础信息

Returns:

FileInfos 生成模板的文件基础信息

setFileInfos

public void setFileInfos(FileInfo[] FileInfos)

Set 生成模板的文件基础信息

Parameters:

FileInfos - 生成模板的文件基础信息

getAttachmentResourceIds

public String[] getAttachmentResourceIds()

Get 附件关联的资源ID

Returns:

AttachmentResourceIds 附件关联的资源ID

setAttachmentResourceIds

public void setAttachmentResourceIds(String[] AttachmentResourceIds)

Set 附件关联的资源ID

Parameters:

AttachmentResourceIds - 附件关联的资源ID

getSignOrder

public Long[] getSignOrder()

Get 签署顺序 无序 -1 有序为序列数字 0,1,2

Returns:

SignOrder 签署顺序 无序 -1 有序为序列数字 0,1,2

setSignOrder

public void setSignOrder(Long[] SignOrder)

Set 签署顺序 无序 -1 有序为序列数字 0,1,2

Parameters:

SignOrder - 签署顺序 无序 -1 有序为序列数字 0,1,2

getRecipients

public Recipient[] getRecipients()

Get 模板中的签署参与方列表

Returns:

Recipients 模板中的签署参与方列表

setRecipients

public void setRecipients(Recipient[] Recipients)

Set 模板中的签署参与方列表

Parameters:

Recipients - 模板中的签署参与方列表

getComponents

public Component[] getComponents()

Get 模板的填充控件列表

Returns:

Components 模板的填充控件列表

setComponents

public void setComponents(Component[] Components)

Set 模板的填充控件列表

Parameters:

Components - 模板的填充控件列表

getSignComponents

public Component[] getSignComponents()

Get 模板中的签署控件列表

Returns:

SignComponents 模板中的签署控件列表

setSignComponents

public void setSignComponents(Component[] SignComponents)

Set 模板中的签署控件列表

Parameters:

SignComponents - 模板中的签署控件列表

getStatus

public Long getStatus()

Get 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用

Returns:

Status 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用

setStatus

public void setStatus(Long Status)

Set 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用

Parameters:

Status - 模板状态 -1:不可用 0:草稿态 1:正式态，可以正常使用

getCreator

public String getCreator()

Get 模板的创建者信息，电子签系统用户ID

Returns:

Creator 模板的创建者信息，电子签系统用户ID

setCreator

public void setCreator(String Creator)

Set 模板的创建者信息，电子签系统用户ID

Parameters:

Creator - 模板的创建者信息，电子签系统用户ID

getCreatedOn

public Long getCreatedOn()

Get 模板创建的时间戳，格式为Unix标准时间戳（秒）

Returns:

CreatedOn 模板创建的时间戳，格式为Unix标准时间戳（秒）

setCreatedOn

public void setCreatedOn(Long CreatedOn)

Set 模板创建的时间戳，格式为Unix标准时间戳（秒）

Parameters:

CreatedOn - 模板创建的时间戳，格式为Unix标准时间戳（秒）

getPromoter

public Recipient getPromoter()

Get 发起方参与信息Promoter

Returns:

Promoter 发起方参与信息Promoter

setPromoter

public void setPromoter(Recipient Promoter)

Set 发起方参与信息Promoter

Parameters:

Promoter - 发起方参与信息Promoter

getTemplateType

public Long getTemplateType()

Get 模板类型： 1 静默签, 3 普通模板

Returns:

TemplateType 模板类型： 1 静默签, 3 普通模板

setTemplateType

public void setTemplateType(Long TemplateType)

Set 模板类型： 1 静默签, 3 普通模板

Parameters:

TemplateType - 模板类型： 1 静默签, 3 普通模板

getAvailable

public Long getAvailable()

Get 模板可用状态： 1 启用（默认） 2 停用

Returns:

Available 模板可用状态： 1 启用（默认） 2 停用

setAvailable

public void setAvailable(Long Available)

Set 模板可用状态： 1 启用（默认） 2 停用

Parameters:

Available - 模板可用状态： 1 启用（默认） 2 停用

getOrganizationId

public String getOrganizationId()

Get 创建模板的企业ID，电子签的机构ID

Returns:

OrganizationId 创建模板的企业ID，电子签的机构ID

setOrganizationId

public void setOrganizationId(String OrganizationId)

Set 创建模板的企业ID，电子签的机构ID

Parameters:

OrganizationId - 创建模板的企业ID，电子签的机构ID

getPreviewUrl

public String getPreviewUrl()

Get 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。

Returns:

PreviewUrl 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。

setPreviewUrl

public void setPreviewUrl(String PreviewUrl)

Set 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

PreviewUrl - 模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。

getTemplateVersion

public String getTemplateVersion()

Get 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

TemplateVersion 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。

setTemplateVersion

public void setTemplateVersion(String TemplateVersion)

Set 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

TemplateVersion - 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。

getPublished

public Boolean getPublished()

Get 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Published 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。

setPublished

public void setPublished(Boolean Published)

Set 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Published - 模板是否已发布： true-已发布 false-未发布 注意：此字段可能返回 null，表示取不到有效值。

getShareTemplateId

public String getShareTemplateId()

Get 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ShareTemplateId 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。

setShareTemplateId

public void setShareTemplateId(String ShareTemplateId)

Set 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ShareTemplateId - 分享来源的模板ID。用在集团账号子企业模板里 注意：此字段可能返回 null，表示取不到有效值。

getTemplateSeals

public SealInfo[] getTemplateSeals()

Get 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

Returns:

TemplateSeals 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

setTemplateSeals

public void setTemplateSeals(SealInfo[] TemplateSeals)

Set 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

TemplateSeals - 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

getSeals

@Deprecated
public SealInfo[] getSeals()

Deprecated.

Get 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Seals 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

setSeals

@Deprecated
public void setSeals(SealInfo[] Seals)

Deprecated.

Set 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Seals - 模板内部指定的印章列表 注意：此字段可能返回 null，表示取不到有效值。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel