ChannelCreateFlowByFilesRequest (tencentcloud-sdk-java 3.1.1121 API)

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

public class ChannelCreateFlowByFilesRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`ChannelCreateFlowByFilesRequest()`
`ChannelCreateFlowByFilesRequest(ChannelCreateFlowByFilesRequest 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 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
`String`	`getApproverVerifyType()` Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`String`	`getAutoSignScene()` Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
`String`	`getCallbackUrl()` Deprecated.
`CcInfo[]`	`getCcInfos()` Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
`Long`	`getCcNotifyType()` Get 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容： 0：合同发起时通知（默认值） 1：签署完成后通知
`Component[]`	`getComponents()` Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件数据表格等填写控件
`String`	`getCustomerData()` Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`String`	`getCustomShowMap()` Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
`Long`	`getDeadline()` Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`String[]`	`getFileIds()` Get 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
`FlowApproverInfo[]`	`getFlowApprovers()` Get 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
`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 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`UserInfo`	`getOperator()` Deprecated.
`Long`	`getSignBeanTag()` Get 签署方签署控件（印章/签名等）的生成方式： 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。注**: `发起后添加控件功能不支持添加签批控件`
`Boolean`	`getUnordered()` Get 合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
`void`	`setAgent(Agent Agent)` Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
`void`	`setApproverVerifyType(String ApproverVerifyType)` Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`void`	`setAutoSignScene(String AutoSignScene)` Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
`void`	`setCallbackUrl(String CallbackUrl)` Deprecated.
`void`	`setCcInfos(CcInfo[] CcInfos)` Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
`void`	`setCcNotifyType(Long CcNotifyType)` Set 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容： 0：合同发起时通知（默认值） 1：签署完成后通知
`void`	`setComponents(Component[] Components)` Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件数据表格等填写控件
`void`	`setCustomerData(String CustomerData)` Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`void`	`setCustomShowMap(String CustomShowMap)` Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
`void`	`setDeadline(Long Deadline)` Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
`void`	`setFileIds(String[] FileIds)` Set 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
`void`	`setFlowApprovers(FlowApproverInfo[] FlowApprovers)` Set 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
`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 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
`void`	`setNeedSignReview(Boolean NeedSignReview)` Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
`void`	`setOperator(UserInfo Operator)` Deprecated.
`void`	`setSignBeanTag(Long SignBeanTag)` Set 签署方签署控件（印章/签名等）的生成方式： 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。注**: `发起后添加控件功能不支持添加签批控件`
`void`	`setUnordered(Boolean Unordered)` Set 合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
`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
  - ChannelCreateFlowByFilesRequest
```
public ChannelCreateFlowByFilesRequest()
```
  - ChannelCreateFlowByFilesRequest
```
public ChannelCreateFlowByFilesRequest(ChannelCreateFlowByFilesRequest 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
  - getAgent
```
public Agent getAgent()
```
    Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    Returns:
    Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    Parameters:
    Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
  - getFlowName
```
public String getFlowName()
```
    Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
    
    Returns:
    
    FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
    
    Parameters:
    
    FlowName - 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
    
    Returns:
    
    FlowDescription 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
    
    Parameters:
    
    FlowDescription - 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
  - getFlowApprovers
```
public FlowApproverInfo[] getFlowApprovers()
```
    Get 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
    
    Returns:
    
    FlowApprovers 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
  - setFlowApprovers
```
public void setFlowApprovers(FlowApproverInfo[] FlowApprovers)
```
    Set 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
    
    Parameters:
    
    FlowApprovers - 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的FlowApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
  - getFileIds
```
public String[] getFileIds()
```
    Get 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
    
    Returns:
    
    FileIds 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
  - setFileIds
```
public void setFileIds(String[] FileIds)
```
    Set 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
    
    Parameters:
    
    FileIds - 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。`
  - getComponents
```
public Component[] getComponents()
```
    Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    - 单行文本控件
    - 多行文本控件
    - 勾选框控件
    - 数字控件
    - 图片控件
    - 数据表格等填写控件
    Returns:
    Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    单行文本控件
    
    多行文本控件
    
    勾选框控件
    
    数字控件
    
    图片控件
    
    数据表格等填写控件
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    - 单行文本控件
    - 多行文本控件
    - 勾选框控件
    - 数字控件
    - 图片控件
    - 数据表格等填写控件
    Parameters:
    Components - 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
    单行文本控件
    
    多行文本控件
    
    勾选框控件
    
    数字控件
    
    图片控件
    
    数据表格等填写控件
  - getDeadline
```
public Long getDeadline()
```
    Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Returns:
    
    Deadline 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    
    Parameters:
    
    Deadline - 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 该字段已废弃，请使用【应用号配置】中的回调地址
    
    Returns:
    
    CallbackUrl 该字段已废弃，请使用【应用号配置】中的回调地址
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String CallbackUrl)
```
    Deprecated.
    
    Set 该字段已废弃，请使用【应用号配置】中的回调地址
    
    Parameters:
    
    CallbackUrl - 该字段已废弃，请使用【应用号配置】中的回调地址
  - getUnordered
```
public Boolean getUnordered()
```
    Get 合同流程的签署顺序类型：
    - **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    - **true**：无序签署, 本合同多个参与人没有先后签署限制
    注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
    Returns:
    Unordered 合同流程的签署顺序类型：
    **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    
    **true**：无序签署, 本合同多个参与人没有先后签署限制
    注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 合同流程的签署顺序类型：
    - **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    - **true**：无序签署, 本合同多个参与人没有先后签署限制
    注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
    Parameters:
    Unordered - 合同流程的签署顺序类型：
    **false**：(默认)有序签署, 本合同多个参与人需要依次签署
    
    **true**：无序签署, 本合同多个参与人没有先后签署限制
    注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
  - getFlowType
```
public String getFlowType()
```
    Get 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
    
    Returns:
    
    FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
    
    Parameters:
    
    FlowType - 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
  - getCustomShowMap
```
public String getCustomShowMap()
```
    Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
    - {合同名称}
    - {发起方企业}
    - {发起方姓名}
    - {签署方N企业}
    - {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
    Returns:
    CustomShowMap 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
    {合同名称}
    
    {发起方企业}
    
    {发起方姓名}
    
    {签署方N企业}
    
    {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
  - setCustomShowMap
```
public void setCustomShowMap(String CustomShowMap)
```
    Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
    - {合同名称}
    - {发起方企业}
    - {发起方姓名}
    - {签署方N企业}
    - {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
    Parameters:
    CustomShowMap - 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
    {合同名称}
    
    {发起方企业}
    
    {发起方姓名}
    
    {签署方N企业}
    
    {签署方N姓名}
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四
  - getCustomerData
```
public String getCustomerData()
```
    Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Returns:
    
    CustomerData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - setCustomerData
```
public void setCustomerData(String CustomerData)
```
    Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Parameters:
    
    CustomerData - 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - getNeedSignReview
```
public Boolean getNeedSignReview()
```
    Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    - **false**：（默认）不需要审批，直接签署。
    - **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    - 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    - 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    Returns:
    NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    **false**：（默认）不需要审批，直接签署。
    
    **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    
    如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
  - setNeedSignReview
```
public void setNeedSignReview(Boolean NeedSignReview)
```
    Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    - **false**：（默认）不需要审批，直接签署。
    - **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    - 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    - 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    Parameters:
    NeedSignReview - 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
    **false**：（默认）不需要审批，直接签署。
    
    **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    
    如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
  - getApproverVerifyType
```
public String getApproverVerifyType()
```
    Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Returns:
    
    ApproverVerifyType 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - setApproverVerifyType
```
public void setApproverVerifyType(String ApproverVerifyType)
```
    Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Parameters:
    
    ApproverVerifyType - 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - getSignBeanTag
```
public Long getSignBeanTag()
```
    Get 签署方签署控件（印章/签名等）的生成方式：
    - **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    - **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
    注**: `发起后添加控件功能不支持添加签批控件`
    Returns:
    SignBeanTag 签署方签署控件（印章/签名等）的生成方式：
    **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    
    **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
    注**: `发起后添加控件功能不支持添加签批控件`
  - setSignBeanTag
```
public void setSignBeanTag(Long SignBeanTag)
```
    Set 签署方签署控件（印章/签名等）的生成方式：
    - **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    - **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
    注**: `发起后添加控件功能不支持添加签批控件`
    Parameters:
    SignBeanTag - 签署方签署控件（印章/签名等）的生成方式：
    **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    
    **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
    注**: `发起后添加控件功能不支持添加签批控件`
  - getCcInfos
```
public CcInfo[] getCcInfos()
```
    Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
    
    Returns:
    
    CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  - setCcInfos
```
public void setCcInfos(CcInfo[] CcInfos)
```
    Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
    
    Parameters:
    
    CcInfos - 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  - getCcNotifyType
```
public Long getCcNotifyType()
```
    Get 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
    - **0**：合同发起时通知（默认值）
    - **1**：签署完成后通知
    Returns:
    CcNotifyType 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
    **0**：合同发起时通知（默认值）
    
    **1**：签署完成后通知
  - setCcNotifyType
```
public void setCcNotifyType(Long CcNotifyType)
```
    Set 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
    - **0**：合同发起时通知（默认值）
    - **1**：签署完成后通知
    Parameters:
    CcNotifyType - 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
    **0**：合同发起时通知（默认值）
    
    **1**：签署完成后通知
  - 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** : 通用场景
    注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
  - getOperator
```
@Deprecated
public UserInfo getOperator()
```
    Deprecated.
    
    Get 操作者的信息，不用传
    
    Returns:
    
    Operator 操作者的信息，不用传
  - setOperator
```
@Deprecated
public void setOperator(UserInfo Operator)
```
    Deprecated.
    
    Set 操作者的信息，不用传
    
    Parameters:
    
    Operator - 操作者的信息，不用传
  - 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 ChannelCreateFlowByFilesRequest

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

ChannelCreateFlowByFilesRequest

ChannelCreateFlowByFilesRequest

Method Detail

getAgent

setAgent

getFlowName

setFlowName

getFlowDescription

setFlowDescription

getFlowApprovers

setFlowApprovers

getFileIds

setFileIds

getComponents

setComponents

getDeadline

setDeadline

getCallbackUrl

setCallbackUrl

getUnordered

setUnordered

getFlowType

setFlowType

getCustomShowMap

setCustomShowMap

getCustomerData

setCustomerData

getNeedSignReview

setNeedSignReview

getApproverVerifyType

setApproverVerifyType

getSignBeanTag

setSignBeanTag

getCcInfos

setCcInfos

getCcNotifyType

setCcNotifyType

getAutoSignScene

setAutoSignScene

getOperator

setOperator

getFlowDisplayType

setFlowDisplayType

toMap