BaseFlowInfo (tencentcloud-sdk-java 3.1.1121 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.models.BaseFlowInfo

public class BaseFlowInfo
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`BaseFlowInfo()`
`BaseFlowInfo(BaseFlowInfo 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
Modifier and Type	Method and Description
`CcInfo[]`	`getCcInfos()` Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
`Component[]`	`getComponents()` Get 填写控件：文件发起使用
`Long`	`getDeadline()` Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`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个字符，仅限中文、字母、数字和下划线组成。
`FormField[]`	`getFormFields()` Get 填写控件内容，填写的控制的ID-填写的内容对列表
`String`	`getIntelligentStatus()` Get 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
`Boolean`	`getNeedCreateReview()` Get 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`Boolean`	`getUnordered()` Get 合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制
`String`	`getUserData()` Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`void`	`setCcInfos(CcInfo[] CcInfos)` Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
`void`	`setComponents(Component[] Components)` Set 填写控件：文件发起使用
`void`	`setDeadline(Long Deadline)` Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`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`	`setFormFields(FormField[] FormFields)` Set 填写控件内容，填写的控制的ID-填写的内容对列表
`void`	`setIntelligentStatus(String IntelligentStatus)` Set 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
`void`	`setNeedCreateReview(Boolean NeedCreateReview)` Set 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
`void`	`setNeedSignReview(Boolean NeedSignReview)` Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`void`	`setUnordered(Boolean Unordered)` Set 合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制
`void`	`setUserData(String UserData)` Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`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
  - BaseFlowInfo
```
public BaseFlowInfo()
```
  - BaseFlowInfo
```
public BaseFlowInfo(BaseFlowInfo 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，只能由中文、字母、数字和下划线组成。
  - getDeadline
```
public Long getDeadline()
```
    Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Returns:
    
    Deadline 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Parameters:
    
    Deadline - 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - 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个字符。
  - getUnordered
```
public Boolean getUnordered()
```
    Get 合同流程的签署顺序类型： false**：(默认)有序签署, 本合同多个参与人需要依次签署 true**：无序签署, 本合同多个参与人没有先后签署限制
    
    Returns:
    
    Unordered 合同流程的签署顺序类型： false**：(默认)有序签署, 本合同多个参与人需要依次签署 true**：无序签署, 本合同多个参与人没有先后签署限制
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 合同流程的签署顺序类型： false**：(默认)有序签署, 本合同多个参与人需要依次签署 true**：无序签署, 本合同多个参与人没有先后签署限制
    
    Parameters:
    
    Unordered - 合同流程的签署顺序类型： false**：(默认)有序签署, 本合同多个参与人需要依次签署 true**：无序签署, 本合同多个参与人没有先后签署限制
  - getIntelligentStatus
```
public String getIntelligentStatus()
```
    Get 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
    
    Returns:
    
    IntelligentStatus 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
  - setIntelligentStatus
```
public void setIntelligentStatus(String IntelligentStatus)
```
    Set 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
    
    Parameters:
    
    IntelligentStatus - 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
  - getFormFields
```
public FormField[] getFormFields()
```
    Get 填写控件内容，填写的控制的ID-填写的内容对列表
    
    Returns:
    
    FormFields 填写控件内容，填写的控制的ID-填写的内容对列表
  - setFormFields
```
public void setFormFields(FormField[] FormFields)
```
    Set 填写控件内容，填写的控制的ID-填写的内容对列表
    
    Parameters:
    
    FormFields - 填写控件内容，填写的控制的ID-填写的内容对列表
  - getNeedSignReview
```
public Boolean getNeedSignReview()
```
    Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    - **false**：（默认）不需要审批，直接签署。
    - **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    - 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    - 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    Returns:
    NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    **false**：（默认）不需要审批，直接签署。
    
    **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    
    如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
  - setNeedSignReview
```
public void setNeedSignReview(Boolean NeedSignReview)
```
    Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    - **false**：（默认）不需要审批，直接签署。
    - **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    - 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    - 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    Parameters:
    NeedSignReview - 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    **false**：（默认）不需要审批，直接签署。
    
    **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    
    如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
  - getUserData
```
public String getUserData()
```
    Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Returns:
    
    UserData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - setUserData
```
public void setUserData(String UserData)
```
    Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Parameters:
    
    UserData - 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - getCcInfos
```
public CcInfo[] getCcInfos()
```
    Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
    
    Returns:
    
    CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  - setCcInfos
```
public void setCcInfos(CcInfo[] CcInfos)
```
    Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
    
    Parameters:
    
    CcInfos - 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  - getNeedCreateReview
```
public Boolean getNeedCreateReview()
```
    Get 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
    
    Returns:
    
    NeedCreateReview 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
  - setNeedCreateReview
```
public void setNeedCreateReview(Boolean NeedCreateReview)
```
    Set 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
    
    Parameters:
    
    NeedCreateReview - 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
  - getComponents
```
public Component[] getComponents()
```
    Get 填写控件：文件发起使用
    
    Returns:
    
    Components 填写控件：文件发起使用
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 填写控件：文件发起使用
    
    Parameters:
    
    Components - 填写控件：文件发起使用
  - 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 BaseFlowInfo

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

BaseFlowInfo

BaseFlowInfo

Method Detail

getFlowName

setFlowName

getDeadline

setDeadline

getFlowType

setFlowType

getFlowDescription

setFlowDescription

getUnordered

setUnordered

getIntelligentStatus

setIntelligentStatus

getFormFields

setFormFields

getNeedSignReview

setNeedSignReview

getUserData

setUserData

getCcInfos

setCcInfos

getNeedCreateReview

setNeedCreateReview

getComponents

setComponents

getFlowDisplayType

setFlowDisplayType

toMap