com.tencentcloudapi.essbasic.v20210526.models.FlowInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.essbasic.v20210526.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class FlowInfo extends AbstractModel {
/**
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
*/
@SerializedName("TemplateId")
@Expose
private String TemplateId;
/**
* 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
*/
@SerializedName("FlowApprovers")
@Expose
private FlowApproverInfo [] FlowApprovers;
/**
* 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
*/
@SerializedName("FormFields")
@Expose
private FormField [] FormFields;
/**
* 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 合同流程描述信息(可自定义此描述),最大长度1000个字符。
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("CustomerData")
@Expose
private String CustomerData;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同
发起方:腾讯公司(张三)
签署方:李四
![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
*/
@SerializedName("CustomShowMap")
@Expose
private String CustomShowMap;
/**
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
@SerializedName("CcInfos")
@Expose
private CcInfo [] CcInfos;
/**
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
*/
@SerializedName("CcNotifyType")
@Expose
private Long CcNotifyType;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
- **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
*/
@SerializedName("AutoSignScene")
@Expose
private String AutoSignScene;
/**
* 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
*/
@SerializedName("FlowDisplayType")
@Expose
private Long FlowDisplayType;
/**
* Get 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
* @return FlowName 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
*/
public String getFlowName() {
return this.FlowName;
}
/**
* Set 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
* @param FlowName 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
*/
public void setFlowName(String FlowName) {
this.FlowName = FlowName;
}
/**
* Get 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
* @return Deadline 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
* @param Deadline 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
* @return TemplateId 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
*/
public String getTemplateId() {
return this.TemplateId;
}
/**
* Set 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
* @param TemplateId 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
*/
public void setTemplateId(String TemplateId) {
this.TemplateId = TemplateId;
}
/**
* Get 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
* @return FlowApprovers 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
*/
public FlowApproverInfo [] getFlowApprovers() {
return this.FlowApprovers;
}
/**
* Set 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
* @param FlowApprovers 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
*/
public void setFlowApprovers(FlowApproverInfo [] FlowApprovers) {
this.FlowApprovers = FlowApprovers;
}
/**
* Get 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
* @return FormFields 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
*/
public FormField [] getFormFields() {
return this.FormFields;
}
/**
* Set 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
* @param FormFields 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
*/
public void setFormFields(FormField [] FormFields) {
this.FormFields = FormFields;
}
/**
* Get 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
* @return CallbackUrl 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
* @deprecated
*/
@Deprecated
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
* @param CallbackUrl 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
* @deprecated
*/
@Deprecated
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* Get 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
* @return FlowType 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
* @param FlowType 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
*/
public void setFlowType(String FlowType) {
this.FlowType = FlowType;
}
/**
* Get 合同流程描述信息(可自定义此描述),最大长度1000个字符。
* @return FlowDescription 合同流程描述信息(可自定义此描述),最大长度1000个字符。
*/
public String getFlowDescription() {
return this.FlowDescription;
}
/**
* Set 合同流程描述信息(可自定义此描述),最大长度1000个字符。
* @param FlowDescription 合同流程描述信息(可自定义此描述),最大长度1000个字符。
*/
public void setFlowDescription(String FlowDescription) {
this.FlowDescription = FlowDescription;
}
/**
* Get 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @return CustomerData 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getCustomerData() {
return this.CustomerData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @param CustomerData 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setCustomerData(String CustomerData) {
this.CustomerData = CustomerData;
}
/**
* Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同
发起方:腾讯公司(张三)
签署方:李四
![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
* @return CustomShowMap 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同
发起方:腾讯公司(张三)
签署方:李四
![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
*/
public String getCustomShowMap() {
return this.CustomShowMap;
}
/**
* Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同
发起方:腾讯公司(张三)
签署方:李四
![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
* @param CustomShowMap 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同
发起方:腾讯公司(张三)
签署方:李四
![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
*/
public void setCustomShowMap(String CustomShowMap) {
this.CustomShowMap = CustomShowMap;
}
/**
* Get 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。
* @return CcInfos 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
public CcInfo [] getCcInfos() {
return this.CcInfos;
}
/**
* Set 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。
* @param CcInfos 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
public void setCcInfos(CcInfo [] CcInfos) {
this.CcInfos = CcInfos;
}
/**
* Get 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
* @return NeedSignReview 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
* @param NeedSignReview 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* Get 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
* @return CcNotifyType 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
*/
public Long getCcNotifyType() {
return this.CcNotifyType;
}
/**
* Set 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
* @param CcNotifyType 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
*/
public void setCcNotifyType(Long CcNotifyType) {
this.CcNotifyType = CcNotifyType;
}
/**
* Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
- **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
* @return AutoSignScene 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
- **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
*/
public String getAutoSignScene() {
return this.AutoSignScene;
}
/**
* Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
- **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
* @param AutoSignScene 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
- **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
*/
public void setAutoSignScene(String AutoSignScene) {
this.AutoSignScene = AutoSignScene;
}
/**
* Get 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
* @return FlowDisplayType 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
*/
public Long getFlowDisplayType() {
return this.FlowDisplayType;
}
/**
* Set 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
* @param FlowDisplayType 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
*/
public void setFlowDisplayType(Long FlowDisplayType) {
this.FlowDisplayType = FlowDisplayType;
}
public FlowInfo() {
}
/**
* 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.
*/
public FlowInfo(FlowInfo source) {
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.TemplateId != null) {
this.TemplateId = new String(source.TemplateId);
}
if (source.FlowApprovers != null) {
this.FlowApprovers = new FlowApproverInfo[source.FlowApprovers.length];
for (int i = 0; i < source.FlowApprovers.length; i++) {
this.FlowApprovers[i] = new FlowApproverInfo(source.FlowApprovers[i]);
}
}
if (source.FormFields != null) {
this.FormFields = new FormField[source.FormFields.length];
for (int i = 0; i < source.FormFields.length; i++) {
this.FormFields[i] = new FormField(source.FormFields[i]);
}
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
if (source.CustomerData != null) {
this.CustomerData = new String(source.CustomerData);
}
if (source.CustomShowMap != null) {
this.CustomShowMap = new String(source.CustomShowMap);
}
if (source.CcInfos != null) {
this.CcInfos = new CcInfo[source.CcInfos.length];
for (int i = 0; i < source.CcInfos.length; i++) {
this.CcInfos[i] = new CcInfo(source.CcInfos[i]);
}
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.CcNotifyType != null) {
this.CcNotifyType = new Long(source.CcNotifyType);
}
if (source.AutoSignScene != null) {
this.AutoSignScene = new String(source.AutoSignScene);
}
if (source.FlowDisplayType != null) {
this.FlowDisplayType = new Long(source.FlowDisplayType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "TemplateId", this.TemplateId);
this.setParamArrayObj(map, prefix + "FlowApprovers.", this.FlowApprovers);
this.setParamArrayObj(map, prefix + "FormFields.", this.FormFields);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamSimple(map, prefix + "FlowDescription", this.FlowDescription);
this.setParamSimple(map, prefix + "CustomerData", this.CustomerData);
this.setParamSimple(map, prefix + "CustomShowMap", this.CustomShowMap);
this.setParamArrayObj(map, prefix + "CcInfos.", this.CcInfos);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "CcNotifyType", this.CcNotifyType);
this.setParamSimple(map, prefix + "AutoSignScene", this.AutoSignScene);
this.setParamSimple(map, prefix + "FlowDisplayType", this.FlowDisplayType);
}
}