TemplateInfo (tencentcloud-sdk-java 3.1.1139 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Long`	`getAvailable()` Get 模板可用状态的取值通常为以下两种： 1：启用（默认），表示模板处于启用状态，可以被用户正常使用。 2：停用，表示模板处于停用状态，禁止用户使用该模板。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getChannelAutoSave()` Get 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
`String`	`getChannelTemplateId()` Get 本模板关联的第三方应用平台企业模板ID
`String`	`getChannelTemplateName()` Get 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
`Component[]`	`getComponents()` Get 模板的填充控件列表
`Long`	`getCreatedOn()` Get 模板创建的时间戳，格式为Unix标准时间戳（秒）
`String`	`getCreator()` Get 模板的创建者名字
`String`	`getDescription()` Get 模板描述信息
`Boolean`	`getIsPromoter()` Deprecated.
`String`	`getPdfUrl()` Get 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getPreviewUrl()` Get 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
`Recipient[]`	`getRecipients()` Get 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
`Component[]`	`getSignComponents()` Get 此模板中的签署控件列表
`String`	`getTemplateId()` Get 模板ID，模板的唯一标识
`String`	`getTemplateName()` Get 模板名
`Long`	`getTemplateType()` Get 模板类型：1-静默签；3-普通模板
`String`	`getTemplateVersion()` Get 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setAvailable(Long Available)` Set 模板可用状态的取值通常为以下两种： 1：启用（默认），表示模板处于启用状态，可以被用户正常使用。 2：停用，表示模板处于停用状态，禁止用户使用该模板。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setChannelAutoSave(Long ChannelAutoSave)` Set 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
`void`	`setChannelTemplateId(String ChannelTemplateId)` Set 本模板关联的第三方应用平台企业模板ID
`void`	`setChannelTemplateName(String ChannelTemplateName)` Set 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
`void`	`setComponents(Component[] Components)` Set 模板的填充控件列表
`void`	`setCreatedOn(Long CreatedOn)` Set 模板创建的时间戳，格式为Unix标准时间戳（秒）
`void`	`setCreator(String Creator)` Set 模板的创建者名字
`void`	`setDescription(String Description)` Set 模板描述信息
`void`	`setIsPromoter(Boolean IsPromoter)` Deprecated.
`void`	`setPdfUrl(String PdfUrl)` Set 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setPreviewUrl(String PreviewUrl)` Set 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRecipients(Recipient[] Recipients)` Set 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
`void`	`setSignComponents(Component[] SignComponents)` Set 此模板中的签署控件列表
`void`	`setTemplateId(String TemplateId)` Set 模板ID，模板的唯一标识
`void`	`setTemplateName(String TemplateName)` Set 模板名
`void`	`setTemplateType(Long TemplateType)` Set 模板类型：1-静默签；3-普通模板
`void`	`setTemplateVersion(String TemplateVersion)` Set 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 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, 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
  - 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 - 模板描述信息
  - getComponents
```
public Component[] getComponents()
```
    Get 模板的填充控件列表
    
    Returns:
    
    Components 模板的填充控件列表
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 模板的填充控件列表
    
    Parameters:
    
    Components - 模板的填充控件列表
  - getRecipients
```
public Recipient[] getRecipients()
```
    Get 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
    
    Returns:
    
    Recipients 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
  - setRecipients
```
public void setRecipients(Recipient[] Recipients)
```
    Set 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
    
    Parameters:
    
    Recipients - 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
  - getSignComponents
```
public Component[] getSignComponents()
```
    Get 此模板中的签署控件列表
    
    Returns:
    
    SignComponents 此模板中的签署控件列表
  - setSignComponents
```
public void setSignComponents(Component[] SignComponents)
```
    Set 此模板中的签署控件列表
    
    Parameters:
    
    SignComponents - 此模板中的签署控件列表
  - getTemplateType
```
public Long getTemplateType()
```
    Get 模板类型：1-静默签；3-普通模板
    
    Returns:
    
    TemplateType 模板类型：1-静默签；3-普通模板
  - setTemplateType
```
public void setTemplateType(Long TemplateType)
```
    Set 模板类型：1-静默签；3-普通模板
    
    Parameters:
    
    TemplateType - 模板类型：1-静默签；3-普通模板
  - getIsPromoter
```
@Deprecated
public Boolean getIsPromoter()
```
    Deprecated.
    
    Get 是否是发起人 ,已弃用
    
    Returns:
    
    IsPromoter 是否是发起人 ,已弃用
  - setIsPromoter
```
@Deprecated
public void setIsPromoter(Boolean IsPromoter)
```
    Deprecated.
    
    Set 是否是发起人 ,已弃用
    
    Parameters:
    
    IsPromoter - 是否是发起人 ,已弃用
  - getCreator
```
public String getCreator()
```
    Get 模板的创建者名字
    
    Returns:
    
    Creator 模板的创建者名字
  - setCreator
```
public void setCreator(String Creator)
```
    Set 模板的创建者名字
    
    Parameters:
    
    Creator - 模板的创建者名字
  - getCreatedOn
```
public Long getCreatedOn()
```
    Get 模板创建的时间戳，格式为Unix标准时间戳（秒）
    
    Returns:
    
    CreatedOn 模板创建的时间戳，格式为Unix标准时间戳（秒）
  - setCreatedOn
```
public void setCreatedOn(Long CreatedOn)
```
    Set 模板创建的时间戳，格式为Unix标准时间戳（秒）
    
    Parameters:
    
    CreatedOn - 模板创建的时间戳，格式为Unix标准时间戳（秒）
  - getPreviewUrl
```
public String getPreviewUrl()
```
    Get 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    PreviewUrl 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
  - setPreviewUrl
```
public void setPreviewUrl(String PreviewUrl)
```
    Set 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    PreviewUrl - 模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。注意：此字段可能返回 null，表示取不到有效值。
  - getPdfUrl
```
public String getPdfUrl()
```
    Get 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    PdfUrl 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
  - setPdfUrl
```
public void setPdfUrl(String PdfUrl)
```
    Set 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    PdfUrl - 第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
  - getChannelTemplateId
```
public String getChannelTemplateId()
```
    Get 本模板关联的第三方应用平台企业模板ID
    
    Returns:
    
    ChannelTemplateId 本模板关联的第三方应用平台企业模板ID
  - setChannelTemplateId
```
public void setChannelTemplateId(String ChannelTemplateId)
```
    Set 本模板关联的第三方应用平台企业模板ID
    
    Parameters:
    
    ChannelTemplateId - 本模板关联的第三方应用平台企业模板ID
  - getChannelTemplateName
```
public String getChannelTemplateName()
```
    Get 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ChannelTemplateName 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
  - setChannelTemplateName
```
public void setChannelTemplateName(String ChannelTemplateName)
```
    Set 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ChannelTemplateName - 本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
  - getChannelAutoSave
```
public Long getChannelAutoSave()
```
    Get 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ChannelAutoSave 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
  - setChannelAutoSave
```
public void setChannelAutoSave(Long ChannelAutoSave)
```
    Set 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ChannelAutoSave - 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
  - getTemplateVersion
```
public String getTemplateVersion()
```
    Get 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    TemplateVersion 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 null，表示取不到有效值。
  - setTemplateVersion
```
public void setTemplateVersion(String TemplateVersion)
```
    Set 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    TemplateVersion - 模板版本，由全数字字符组成。默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。注意：此字段可能返回 null，表示取不到有效值。
  - getAvailable
```
public Long getAvailable()
```
    Get 模板可用状态的取值通常为以下两种：
    - 1：启用（默认），表示模板处于启用状态，可以被用户正常使用。
    - 2：停用，表示模板处于停用状态，禁止用户使用该模板。
    注意：此字段可能返回 null，表示取不到有效值。
    Returns:
    Available 模板可用状态的取值通常为以下两种：
    1：启用（默认），表示模板处于启用状态，可以被用户正常使用。
    
    2：停用，表示模板处于停用状态，禁止用户使用该模板。
    注意：此字段可能返回 null，表示取不到有效值。
  - setAvailable
```
public void setAvailable(Long Available)
```
    Set 模板可用状态的取值通常为以下两种：
    - 1：启用（默认），表示模板处于启用状态，可以被用户正常使用。
    - 2：停用，表示模板处于停用状态，禁止用户使用该模板。
    注意：此字段可能返回 null，表示取不到有效值。
    Parameters:
    Available - 模板可用状态的取值通常为以下两种：
    1：启用（默认），表示模板处于启用状态，可以被用户正常使用。
    
    2：停用，表示模板处于停用状态，禁止用户使用该模板。
    注意：此字段可能返回 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

Class TemplateInfo

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

TemplateInfo

TemplateInfo

Method Detail

getTemplateId

setTemplateId

getTemplateName

setTemplateName

getDescription

setDescription

getComponents

setComponents

getRecipients

setRecipients

getSignComponents

setSignComponents

getTemplateType

setTemplateType

getIsPromoter

setIsPromoter

getCreator

setCreator

getCreatedOn

setCreatedOn

getPreviewUrl

setPreviewUrl

getPdfUrl

setPdfUrl

getChannelTemplateId

setChannelTemplateId

getChannelTemplateName

setChannelTemplateName

getChannelAutoSave

setChannelAutoSave

getTemplateVersion

setTemplateVersion

getAvailable

setAvailable

toMap