public class TemplateInfo extends AbstractModel
header, skipSign
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.
|
Modifier and Type | Method and Description |
---|---|
String[] |
getAttachmentResourceIds()
Get 此模板里边附件的资源ID
|
Long |
getAvailable()
Get 模板可用状态可以分为以下两种:
1:(默认)启用状态,即模板可以正常使用。
2:停用状态,即模板暂时无法使用。
可到控制台启停模板
|
Component[] |
getComponents()
Get 模板的填充控件列表
[点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
|
Long |
getCreatedOn()
Get 模板创建的时间戳,格式为Unix标准时间戳(秒)
|
String |
getCreator()
Get 模板的创建者信息,用户的名字
注: `是创建者的名字,而非创建者的用户ID`
|
String |
getCreatorId()
Get 模板创建人用户ID
|
String |
getDescription()
Get 模板描述信息
|
String[] |
getDocumentResourceIds()
Get 此模板的资源ID
|
FileInfo[] |
getFileInfos()
Get 生成模板的文件基础信息
|
String |
getOrganizationId()
Get 创建模板的企业ID,电子签的机构ID
|
String |
getPreviewUrl()
Get 模板的H5预览链接,有效期5分钟。
可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
注意:此字段可能返回 null,表示取不到有效值。
|
Recipient |
getPromoter()
Get 此模板创建方角色信息。
[点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
Boolean |
getPublished()
Get 模板是否已发布可以分为以下两种状态:
true:已发布状态,表示该模板已经发布并可以正常使用。
false:未发布状态,表示该模板还未发布,无法使用。
注意:此字段可能返回 null,表示取不到有效值。
|
Recipient[] |
getRecipients()
Get 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
[点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
SealInfo[] |
getSeals()
Deprecated.
|
String |
getShareTemplateId()
Get 集体账号场景下: 集团账号分享给子企业的模板的来源模板ID。
注意:此字段可能返回 null,表示取不到有效值。
|
Component[] |
getSignComponents()
Get 此模板中的签署控件列表
[点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
|
Long[] |
getSignOrder()
Get 签署人参与签署的顺序,可以分为以下两种方式:
无序:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
有序:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
|
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 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
注意:此字段可能返回 null,表示取不到有效值。
|
UserFlowType |
getUserFlowType()
Get 用户自定义合同类型。
返回配置模板的时候选择的合同类型。[点击查看配置的位置](https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png)
自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setAttachmentResourceIds(String[] AttachmentResourceIds)
Set 此模板里边附件的资源ID
|
void |
setAvailable(Long Available)
Set 模板可用状态可以分为以下两种:
1:(默认)启用状态,即模板可以正常使用。
2:停用状态,即模板暂时无法使用。
可到控制台启停模板
|
void |
setComponents(Component[] Components)
Set 模板的填充控件列表
[点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
|
void |
setCreatedOn(Long CreatedOn)
Set 模板创建的时间戳,格式为Unix标准时间戳(秒)
|
void |
setCreator(String Creator)
Set 模板的创建者信息,用户的名字
注: `是创建者的名字,而非创建者的用户ID`
|
void |
setCreatorId(String CreatorId)
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 模板的H5预览链接,有效期5分钟。
可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setPromoter(Recipient Promoter)
Set 此模板创建方角色信息。
[点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
void |
setPublished(Boolean Published)
Set 模板是否已发布可以分为以下两种状态:
true:已发布状态,表示该模板已经发布并可以正常使用。
false:未发布状态,表示该模板还未发布,无法使用。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setRecipients(Recipient[] Recipients)
Set 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
[点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
void |
setSeals(SealInfo[] Seals)
Deprecated.
|
void |
setShareTemplateId(String ShareTemplateId)
Set 集体账号场景下: 集团账号分享给子企业的模板的来源模板ID。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setSignComponents(Component[] SignComponents)
Set 此模板中的签署控件列表
[点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
|
void |
setSignOrder(Long[] SignOrder)
Set 签署人参与签署的顺序,可以分为以下两种方式:
无序:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
有序:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
|
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 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setUserFlowType(UserFlowType UserFlowType)
Set 用户自定义合同类型。
返回配置模板的时候选择的合同类型。[点击查看配置的位置](https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png)
自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
注意:此字段可能返回 null,表示取不到有效值。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public TemplateInfo()
public TemplateInfo(TemplateInfo source)
public String getTemplateId()
public void setTemplateId(String TemplateId)
TemplateId
- 模板ID,模板的唯一标识public String getTemplateName()
public void setTemplateName(String TemplateName)
TemplateName
- 模板的名字public Recipient[] getRecipients()
public void setRecipients(Recipient[] Recipients)
Recipients
- 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
[点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)public Component[] getComponents()
public void setComponents(Component[] Components)
Components
- 模板的填充控件列表
[点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)public Component[] getSignComponents()
public void setSignComponents(Component[] SignComponents)
SignComponents
- 此模板中的签署控件列表
[点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)public String getDescription()
public void setDescription(String Description)
Description
- 模板描述信息public String[] getDocumentResourceIds()
public void setDocumentResourceIds(String[] DocumentResourceIds)
DocumentResourceIds
- 此模板的资源IDpublic FileInfo[] getFileInfos()
public void setFileInfos(FileInfo[] FileInfos)
FileInfos
- 生成模板的文件基础信息public String[] getAttachmentResourceIds()
public void setAttachmentResourceIds(String[] AttachmentResourceIds)
AttachmentResourceIds
- 此模板里边附件的资源IDpublic Long[] getSignOrder()
public void setSignOrder(Long[] SignOrder)
SignOrder
- 签署人参与签署的顺序,可以分为以下两种方式:
无序:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
有序:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}public Long getStatus()
public void setStatus(Long Status)
Status
- 此模板的状态可以分为以下几种:
-1:不可用状态。
0:草稿态,即模板正在编辑或未发布状态。
1:正式态,只有正式态的模板才可以发起合同。public String getCreator()
public void setCreator(String Creator)
Creator
- 模板的创建者信息,用户的名字
注: `是创建者的名字,而非创建者的用户ID`public Long getCreatedOn()
public void setCreatedOn(Long CreatedOn)
CreatedOn
- 模板创建的时间戳,格式为Unix标准时间戳(秒)public Recipient getPromoter()
public void setPromoter(Recipient Promoter)
Promoter
- 此模板创建方角色信息。
[点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)public Long getTemplateType()
public void setTemplateType(Long TemplateType)
TemplateType
- 模板类型可以分为以下两种:
1:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。
3:普通模板,即签署人需要手动进行签署操作。public Long getAvailable()
public void setAvailable(Long Available)
Available
- 模板可用状态可以分为以下两种:
1:(默认)启用状态,即模板可以正常使用。
2:停用状态,即模板暂时无法使用。
可到控制台启停模板public String getOrganizationId()
public void setOrganizationId(String OrganizationId)
OrganizationId
- 创建模板的企业ID,电子签的机构IDpublic String getCreatorId()
public void setCreatorId(String CreatorId)
CreatorId
- 模板创建人用户IDpublic String getPreviewUrl()
public void setPreviewUrl(String PreviewUrl)
PreviewUrl
- 模板的H5预览链接,有效期5分钟。
可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
注意:此字段可能返回 null,表示取不到有效值。public UserFlowType getUserFlowType()
public void setUserFlowType(UserFlowType UserFlowType)
UserFlowType
- 用户自定义合同类型。
返回配置模板的时候选择的合同类型。[点击查看配置的位置](https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png)
自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
注意:此字段可能返回 null,表示取不到有效值。public String getTemplateVersion()
public void setTemplateVersion(String TemplateVersion)
TemplateVersion
- 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
注意:此字段可能返回 null,表示取不到有效值。public Boolean getPublished()
public void setPublished(Boolean Published)
Published
- 模板是否已发布可以分为以下两种状态:
true:已发布状态,表示该模板已经发布并可以正常使用。
false:未发布状态,表示该模板还未发布,无法使用。
注意:此字段可能返回 null,表示取不到有效值。public String getShareTemplateId()
public void setShareTemplateId(String ShareTemplateId)
ShareTemplateId
- 集体账号场景下: 集团账号分享给子企业的模板的来源模板ID。
注意:此字段可能返回 null,表示取不到有效值。public SealInfo[] getTemplateSeals()
public void setTemplateSeals(SealInfo[] TemplateSeals)
TemplateSeals
- 此模板配置的预填印章列表(包括自动签署指定的印章)
注意:此字段可能返回 null,表示取不到有效值。@Deprecated public SealInfo[] getSeals()
@Deprecated public void setSeals(SealInfo[] Seals)
Seals
- 模板内部指定的印章列表
注意:此字段可能返回 null,表示取不到有效值。Copyright © 2024. All rights reserved.