FlowGroupInfo (tencentcloud-sdk-java 3.1.1139 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ess.v20201111.models.FlowGroupInfo

public class FlowGroupInfo
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`FlowGroupInfo()`
`FlowGroupInfo(FlowGroupInfo 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
`ApproverInfo[]`	`getApprovers()` Get 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
`String`	`getAutoSignScene()` Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
`String`	`getCallbackUrl()` Deprecated.
`Component[]`	`getComponents()` Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件动态表格等填写控件
`Long`	`getDeadline()` Get 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
`String[]`	`getFileIds()` Get 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
`String`	`getFlowDescription()` Get 签署流程描述,最大长度1000个字符
`Long`	`getFlowDisplayType()` Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
`String`	`getFlowName()` Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
`String`	`getFlowType()` Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
`String`	`getTemplateId()` Get 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
`Boolean`	`getUnordered()` Get 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
`String`	`getUserData()` Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`void`	`setApprovers(ApproverInfo[] Approvers)` Set 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
`void`	`setAutoSignScene(String AutoSignScene)` Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
`void`	`setCallbackUrl(String CallbackUrl)` Deprecated.
`void`	`setComponents(Component[] Components)` Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件动态表格等填写控件
`void`	`setDeadline(Long Deadline)` Set 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
`void`	`setFileIds(String[] FileIds)` Set 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
`void`	`setFlowDescription(String FlowDescription)` Set 签署流程描述,最大长度1000个字符
`void`	`setFlowDisplayType(Long FlowDisplayType)` Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
`void`	`setFlowName(String FlowName)` Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
`void`	`setFlowType(String FlowType)` Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
`void`	`setNeedSignReview(Boolean NeedSignReview)` Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
`void`	`setTemplateId(String TemplateId)` Set 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
`void`	`setUnordered(Boolean Unordered)` Set 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
`void`	`setUserData(String UserData)` Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`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
  - FlowGroupInfo
```
public FlowGroupInfo()
```
  - FlowGroupInfo
```
public FlowGroupInfo(FlowGroupInfo 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
  - getFlowName
```
public String getFlowName()
```
    Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
    
    Returns:
    
    FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
    
    Parameters:
    
    FlowName - 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
  - getApprovers
```
public ApproverInfo[] getApprovers()
```
    Get 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
    
    Returns:
    
    Approvers 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
  - setApprovers
```
public void setApprovers(ApproverInfo[] Approvers)
```
    Set 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
    
    Parameters:
    
    Approvers - 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致，否则会导致模板中配置的信息无效。
  - getFileIds
```
public String[] getFileIds()
```
    Get 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
    
    Returns:
    
    FileIds 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
  - setFileIds
```
public void setFileIds(String[] FileIds)
```
    Set 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
    
    Parameters:
    
    FileIds - 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
  - getTemplateId
```
public String getTemplateId()
```
    Get 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    
    Returns:
    
    TemplateId 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
  - setTemplateId
```
public void setTemplateId(String TemplateId)
```
    Set 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    
    Parameters:
    
    TemplateId - 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
  - getFlowType
```
public String getFlowType()
```
    Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
    
    Returns:
    
    FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
    
    Parameters:
    
    FlowType - 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符示例值：劳务合同
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 签署流程描述,最大长度1000个字符
    
    Returns:
    
    FlowDescription 签署流程描述,最大长度1000个字符
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 签署流程描述,最大长度1000个字符
    
    Parameters:
    
    FlowDescription - 签署流程描述,最大长度1000个字符
  - getDeadline
```
public Long getDeadline()
```
    Get 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
    
    Returns:
    
    Deadline 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
    
    Parameters:
    
    Deadline - 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 合同（流程）的回调地址
    
    Returns:
    
    CallbackUrl 合同（流程）的回调地址
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String CallbackUrl)
```
    Deprecated.
    
    Set 合同（流程）的回调地址
    
    Parameters:
    
    CallbackUrl - 合同（流程）的回调地址
  - getUserData
```
public String getUserData()
```
    Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Returns:
    
    UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - setUserData
```
public void setUserData(String UserData)
```
    Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Parameters:
    
    UserData - 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - getUnordered
```
public Boolean getUnordered()
```
    Get 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
    
    Returns:
    
    Unordered 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
    
    Parameters:
    
    Unordered - 发送类型： true：无序签 false：有序签注：默认为false（有序签），请和模板中的配置保持一致示例值：true
  - getComponents
```
public Component[] getComponents()
```
    Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    - 单行文本控件
    - 多行文本控件
    - 勾选框控件
    - 数字控件
    - 图片控件
    - 动态表格等填写控件
    Returns:
    Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    单行文本控件
    
    多行文本控件
    
    勾选框控件
    
    数字控件
    
    图片控件
    
    动态表格等填写控件
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    - 单行文本控件
    - 多行文本控件
    - 勾选框控件
    - 数字控件
    - 图片控件
    - 动态表格等填写控件
    Parameters:
    Components - 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    单行文本控件
    
    多行文本控件
    
    勾选框控件
    
    数字控件
    
    图片控件
    
    动态表格等填写控件
  - getNeedSignReview
```
public Boolean getNeedSignReview()
```
    Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
    
    Returns:
    
    NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
  - setNeedSignReview
```
public void setNeedSignReview(Boolean NeedSignReview)
```
    Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
    
    Parameters:
    
    NeedSignReview - 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。示例值：true
  - getAutoSignScene
```
public String getAutoSignScene()
```
    Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
    
    Returns:
    
    AutoSignScene 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
  - setAutoSignScene
```
public void setAutoSignScene(String AutoSignScene)
```
    Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
    
    Parameters:
    
    AutoSignScene - 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN
  - getFlowDisplayType
```
public Long getFlowDisplayType()
```
    Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    - 0 :合同（默认值）
    - 1 :文件
    - 2 :协议
    效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
    Returns:
    FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    0 :合同（默认值）
    
    1 :文件
    
    2 :协议
    效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
  - setFlowDisplayType
```
public void setFlowDisplayType(Long FlowDisplayType)
```
    Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    - 0 :合同（默认值）
    - 1 :文件
    - 2 :协议
    效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
    Parameters:
    FlowDisplayType - 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    0 :合同（默认值）
    
    1 :文件
    
    2 :协议
    效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
  - 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 FlowGroupInfo

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

FlowGroupInfo

FlowGroupInfo

Method Detail

getFlowName

setFlowName

getApprovers

setApprovers

getFileIds

setFileIds

getTemplateId

setTemplateId

getFlowType

setFlowType

getFlowDescription

setFlowDescription

getDeadline

setDeadline

getCallbackUrl

setCallbackUrl

getUserData

setUserData

getUnordered

setUnordered

getComponents

setComponents

getNeedSignReview

setNeedSignReview

getAutoSignScene

setAutoSignScene

getFlowDisplayType

setFlowDisplayType

toMap