CreateFlowRequest (tencentcloud-sdk-java 3.1.1355 API)

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

public class CreateFlowRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CreateFlowRequest()`
`CreateFlowRequest(CreateFlowRequest 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
`Agent`	`getAgent()` Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`FlowCreateApprover[]`	`getApprovers()` Get 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
`String`	`getAutoSignScene()` Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
`String`	`getCallbackUrl()` Deprecated.
`CcInfo[]`	`getCcInfos()` Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1.
`String`	`getClientToken()` Get 该字段已不再使用
`String`	`getCustomShowMap()` Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
`Long`	`getDeadLine()` Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`String`	`getFlowDescription()` Get 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
`Long`	`getFlowDisplayType()` Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下: ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
`String`	`getFlowName()` Get 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。
`String`	`getFlowType()` Get 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。此合同类型需要跟模板配置的合同类型保持一致。
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`UserInfo`	`getOperator()` Get 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
`String`	`getRelatedFlowId()` Deprecated.
`Long`	`getRemindedOn()` Get 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
`Boolean`	`getUnordered()` Get 合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制注：`请和模板中的配置保持一致`
`String`	`getUserData()` Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`void`	`setAgent(Agent Agent)` Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setApprovers(FlowCreateApprover[] Approvers)` Set 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
`void`	`setAutoSignScene(String AutoSignScene)` Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
`void`	`setCallbackUrl(String CallbackUrl)` Deprecated.
`void`	`setCcInfos(CcInfo[] CcInfos)` Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1.
`void`	`setClientToken(String ClientToken)` Set 该字段已不再使用
`void`	`setCustomShowMap(String CustomShowMap)` Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
`void`	`setDeadLine(Long DeadLine)` Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`void`	`setFlowDescription(String FlowDescription)` Set 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
`void`	`setFlowDisplayType(Long FlowDisplayType)` Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下: ![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 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`void`	`setOperator(UserInfo Operator)` Set 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
`void`	`setRelatedFlowId(String RelatedFlowId)` Deprecated.
`void`	`setRemindedOn(Long RemindedOn)` Set 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
`void`	`setUnordered(Boolean Unordered)` Set 合同流程的签署顺序类型： 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
  - CreateFlowRequest
```
public CreateFlowRequest()
```
  - CreateFlowRequest
```
public CreateFlowRequest(CreateFlowRequest 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
  - getOperator
```
public UserInfo getOperator()
```
    Get 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
    
    Returns:
    
    Operator 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
  - setOperator
```
public void setOperator(UserInfo Operator)
```
    Set 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
    
    Parameters:
    
    Operator - 本合同的发起人，点击查看合同发起人展示的位置注：支持填入集团子公司经办人 userId 代发合同。
  - getFlowName
```
public String getFlowName()
```
    Get 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。
    
    Returns:
    
    FlowName 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。
    
    Parameters:
    
    FlowName - 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。
  - getApprovers
```
public FlowCreateApprover[] getApprovers()
```
    Get 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
    
    Returns:
    
    Approvers 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
  - setApprovers
```
public void setApprovers(FlowCreateApprover[] Approvers)
```
    Set 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
    
    Parameters:
    
    Approvers - 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
    
    Returns:
    
    FlowDescription 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
    
    Parameters:
    
    FlowDescription - 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
  - getFlowType
```
public String getFlowType()
```
    Get 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。此合同类型需要跟模板配置的合同类型保持一致。
    
    Returns:
    
    FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。此合同类型需要跟模板配置的合同类型保持一致。
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。此合同类型需要跟模板配置的合同类型保持一致。
    
    Parameters:
    
    FlowType - 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。此合同类型需要跟模板配置的合同类型保持一致。
  - getClientToken
```
public String getClientToken()
```
    Get 该字段已不再使用
    
    Returns:
    
    ClientToken 该字段已不再使用
  - setClientToken
```
public void setClientToken(String ClientToken)
```
    Set 该字段已不再使用
    
    Parameters:
    
    ClientToken - 该字段已不再使用
  - getDeadLine
```
public Long getDeadLine()
```
    Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Returns:
    
    DeadLine 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - setDeadLine
```
public void setDeadLine(Long DeadLine)
```
    Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Parameters:
    
    DeadLine - 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - getRemindedOn
```
public Long getRemindedOn()
```
    Get 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
    
    Returns:
    
    RemindedOn 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
  - setRemindedOn
```
public void setRemindedOn(Long RemindedOn)
```
    Set 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
    
    Parameters:
    
    RemindedOn - 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
  - 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 合同流程的签署顺序类型：
    - **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    - **true**：无序签署, 本合同多个参与人没有先后签署限制
    注：`请和模板中的配置保持一致`
    Returns:
    Unordered 合同流程的签署顺序类型：
    **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    
    **true**：无序签署, 本合同多个参与人没有先后签署限制
    注：`请和模板中的配置保持一致`
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 合同流程的签署顺序类型：
    - **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    - **true**：无序签署, 本合同多个参与人没有先后签署限制
    注：`请和模板中的配置保持一致`
    Parameters:
    Unordered - 合同流程的签署顺序类型：
    **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    
    **true**：无序签署, 本合同多个参与人没有先后签署限制
    注：`请和模板中的配置保持一致`
  - getCustomShowMap
```
public String getCustomShowMap()
```
    Get 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
    - {合同名称}
    - {发起方企业}
    - {发起方姓名}
    - {签署方N企业}
    - {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
    Returns:
    CustomShowMap 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
    {合同名称}
    
    {发起方企业}
    
    {发起方姓名}
    
    {签署方N企业}
    
    {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
  - setCustomShowMap
```
public void setCustomShowMap(String CustomShowMap)
```
    Set 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
    - {合同名称}
    - {发起方企业}
    - {发起方姓名}
    - {签署方N企业}
    - {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
    Parameters:
    CustomShowMap - 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
    {合同名称}
    
    {发起方企业}
    
    {发起方姓名}
    
    {签署方N企业}
    
    {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
  - 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审批接口通知腾讯电子签平台企业内部审批结果
    如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    
    如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
  - getAgent
```
public Agent getAgent()
```
    Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Returns:
    
    Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Parameters:
    
    Agent - 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - getCcInfos
```
public CcInfo[] getCcInfos()
```
    Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1. 抄送人名单中可以包括自然人以及本企业的员工。 2. 请确保抄送人列表中的成员不与任何签署人重复。
    
    Returns:
    
    CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1. 抄送人名单中可以包括自然人以及本企业的员工。 2. 请确保抄送人列表中的成员不与任何签署人重复。
  - setCcInfos
```
public void setCcInfos(CcInfo[] CcInfos)
```
    Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1. 抄送人名单中可以包括自然人以及本企业的员工。 2. 请确保抄送人列表中的成员不与任何签署人重复。
    
    Parameters:
    
    CcInfos - 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注 1. 抄送人名单中可以包括自然人以及本企业的员工。 2. 请确保抄送人列表中的成员不与任何签署人重复。
  - getAutoSignScene
```
public String getAutoSignScene()
```
    Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
    - **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
    - **OTHER** : 通用场景
    注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
    Returns:
    AutoSignScene 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
    **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
    **OTHER** : 通用场景
    注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
  - setAutoSignScene
```
public void setAutoSignScene(String AutoSignScene)
```
    Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
    - **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
    - **OTHER** : 通用场景
    注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
    Parameters:
    AutoSignScene - 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
    **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
    **OTHER** : 通用场景
    注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
  - getRelatedFlowId
```
@Deprecated
public String getRelatedFlowId()
```
    Deprecated.
    
    Get 暂未开放
    
    Returns:
    
    RelatedFlowId 暂未开放
  - setRelatedFlowId
```
@Deprecated
public void setRelatedFlowId(String RelatedFlowId)
```
    Deprecated.
    
    Set 暂未开放
    
    Parameters:
    
    RelatedFlowId - 暂未开放
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 暂未开放
    
    Returns:
    
    CallbackUrl 暂未开放
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String CallbackUrl)
```
    Deprecated.
    
    Set 暂未开放
    
    Parameters:
    
    CallbackUrl - 暂未开放
  - getFlowDisplayType
```
public Long getFlowDisplayType()
```
    Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    - 0 :合同（默认值）
    - 1 :文件
    - 2 :协议
    - 3 :文书
    效果如下: ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
    Returns:
    FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    0 :合同（默认值）
    
    1 :文件
    
    2 :协议
    3 :文书
    效果如下: ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
  - setFlowDisplayType
```
public void setFlowDisplayType(Long FlowDisplayType)
```
    Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    - 0 :合同（默认值）
    - 1 :文件
    - 2 :协议
    - 3 :文书
    效果如下: ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
    Parameters:
    FlowDisplayType - 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：
    0 :合同（默认值）
    
    1 :文件
    
    2 :协议
    3 :文书
    效果如下: ![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
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class CreateFlowRequest

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

CreateFlowRequest

CreateFlowRequest

Method Detail

getOperator

setOperator

getFlowName

setFlowName

getApprovers

setApprovers

getFlowDescription

setFlowDescription

getFlowType

setFlowType

getClientToken

setClientToken

getDeadLine

setDeadLine

getRemindedOn

setRemindedOn

getUserData

setUserData

getUnordered

setUnordered

getCustomShowMap

setCustomShowMap

getNeedSignReview

setNeedSignReview

getAgent

setAgent

getCcInfos

setCcInfos

getAutoSignScene

setAutoSignScene

getRelatedFlowId

setRelatedFlowId

getCallbackUrl

setCallbackUrl

getFlowDisplayType

setFlowDisplayType

toMap