com.tencentcloudapi.ess.v20201111.models.CreatePrepareFlowRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess 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.ess.v20201111.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 CreatePrepareFlowRequest extends AbstractModel {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
注意:需要同时设置 ResourceType 参数指定资源类型
*/
@SerializedName("ResourceId")
@Expose
private String ResourceId;
/**
* 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
*/
@SerializedName("ResourceType")
@Expose
private Long ResourceType;
/**
* 合同流程的签署顺序类型:
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
- **true**:无序签署, 本合同多个参与人没有先后签署限制
*/
@SerializedName("Unordered")
@Expose
private Boolean Unordered;
/**
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
*/
@SerializedName("UserFlowTypeId")
@Expose
private String UserFlowTypeId;
/**
* 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
*/
@SerializedName("Approvers")
@Expose
private FlowCreateApprover [] Approvers;
/**
* 开启或者关闭智能添加填写区:
- **OPEN**:开启(默认值)
- **CLOSE**:关闭
*/
@SerializedName("IntelligentStatus")
@Expose
private String IntelligentStatus;
/**
* 该字段已废弃,请使用InitiatorComponents
*/
@SerializedName("Components")
@Expose
private Component Components;
/**
* 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
*/
@SerializedName("FlowOption")
@Expose
private CreateFlowOption FlowOption;
/**
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
- **false**:(默认)不需要审批,直接签署。
- **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
*/
@SerializedName("NeedCreateReview")
@Expose
private Boolean NeedCreateReview;
/**
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
*/
@SerializedName("CcInfos")
@Expose
private CcInfo CcInfos;
/**
* 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
*/
@SerializedName("FlowId")
@Expose
private String FlowId;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
*/
@SerializedName("InitiatorComponents")
@Expose
private Component [] InitiatorComponents;
/**
* 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: - 0 :合同(默认值)
- 1 :文件
- 2 :协议
效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
*/
@SerializedName("FlowDisplayType")
@Expose
private Long FlowDisplayType;
/**
* Get 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
注意:需要同时设置 ResourceType 参数指定资源类型
* @return ResourceId 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
注意:需要同时设置 ResourceType 参数指定资源类型
*/
public String getResourceId() {
return this.ResourceId;
}
/**
* Set 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
注意:需要同时设置 ResourceType 参数指定资源类型
* @param ResourceId 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
注意:需要同时设置 ResourceType 参数指定资源类型
*/
public void setResourceId(String ResourceId) {
this.ResourceId = ResourceId;
}
/**
* 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 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
* @return ResourceType 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
*/
public Long getResourceType() {
return this.ResourceType;
}
/**
* Set 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
* @param ResourceType 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
*/
public void setResourceType(Long ResourceType) {
this.ResourceType = ResourceType;
}
/**
* Get 合同流程的签署顺序类型:
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
- **true**:无序签署, 本合同多个参与人没有先后签署限制
* @return Unordered 合同流程的签署顺序类型:
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
- **true**:无序签署, 本合同多个参与人没有先后签署限制
*/
public Boolean getUnordered() {
return this.Unordered;
}
/**
* Set 合同流程的签署顺序类型:
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
- **true**:无序签署, 本合同多个参与人没有先后签署限制
* @param Unordered 合同流程的签署顺序类型:
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
- **true**:无序签署, 本合同多个参与人没有先后签署限制
*/
public void setUnordered(Boolean Unordered) {
this.Unordered = Unordered;
}
/**
* Get 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
* @return Deadline 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
* @param Deadline 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
* @return UserFlowTypeId 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
*/
public String getUserFlowTypeId() {
return this.UserFlowTypeId;
}
/**
* Set 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
* @param UserFlowTypeId 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
*/
public void setUserFlowTypeId(String UserFlowTypeId) {
this.UserFlowTypeId = UserFlowTypeId;
}
/**
* 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 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
* @return Approvers 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
*/
public FlowCreateApprover [] getApprovers() {
return this.Approvers;
}
/**
* Set 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
* @param Approvers 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
*/
public void setApprovers(FlowCreateApprover [] Approvers) {
this.Approvers = Approvers;
}
/**
* Get 开启或者关闭智能添加填写区:
- **OPEN**:开启(默认值)
- **CLOSE**:关闭
* @return IntelligentStatus 开启或者关闭智能添加填写区:
- **OPEN**:开启(默认值)
- **CLOSE**:关闭
*/
public String getIntelligentStatus() {
return this.IntelligentStatus;
}
/**
* Set 开启或者关闭智能添加填写区:
- **OPEN**:开启(默认值)
- **CLOSE**:关闭
* @param IntelligentStatus 开启或者关闭智能添加填写区:
- **OPEN**:开启(默认值)
- **CLOSE**:关闭
*/
public void setIntelligentStatus(String IntelligentStatus) {
this.IntelligentStatus = IntelligentStatus;
}
/**
* Get 该字段已废弃,请使用InitiatorComponents
* @return Components 该字段已废弃,请使用InitiatorComponents
*/
public Component getComponents() {
return this.Components;
}
/**
* Set 该字段已废弃,请使用InitiatorComponents
* @param Components 该字段已废弃,请使用InitiatorComponents
*/
public void setComponents(Component Components) {
this.Components = Components;
}
/**
* Get 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
* @return FlowOption 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
*/
public CreateFlowOption getFlowOption() {
return this.FlowOption;
}
/**
* Set 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
* @param FlowOption 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
*/
public void setFlowOption(CreateFlowOption FlowOption) {
this.FlowOption = FlowOption;
}
/**
* 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 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
* @return NeedCreateReview 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
*/
public Boolean getNeedCreateReview() {
return this.NeedCreateReview;
}
/**
* Set 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
* @param NeedCreateReview 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
*/
public void setNeedCreateReview(Boolean NeedCreateReview) {
this.NeedCreateReview = NeedCreateReview;
}
/**
* Get 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @return UserData 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getUserData() {
return this.UserData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @param UserData 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
/**
* Get 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
* @return CcInfos 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
*/
public CcInfo getCcInfos() {
return this.CcInfos;
}
/**
* Set 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
* @param CcInfos 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
*/
public void setCcInfos(CcInfo CcInfos) {
this.CcInfos = CcInfos;
}
/**
* Get 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
* @return FlowId 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
*/
public String getFlowId() {
return this.FlowId;
}
/**
* Set 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
* @param FlowId 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
*/
public void setFlowId(String FlowId) {
this.FlowId = FlowId;
}
/**
* Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
* @return Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
* @param Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
* @return InitiatorComponents 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
*/
public Component [] getInitiatorComponents() {
return this.InitiatorComponents;
}
/**
* Set 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
* @param InitiatorComponents 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
*/
public void setInitiatorComponents(Component [] InitiatorComponents) {
this.InitiatorComponents = InitiatorComponents;
}
/**
* 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 CreatePrepareFlowRequest() {
}
/**
* 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 CreatePrepareFlowRequest(CreatePrepareFlowRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.ResourceId != null) {
this.ResourceId = new String(source.ResourceId);
}
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.ResourceType != null) {
this.ResourceType = new Long(source.ResourceType);
}
if (source.Unordered != null) {
this.Unordered = new Boolean(source.Unordered);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.UserFlowTypeId != null) {
this.UserFlowTypeId = new String(source.UserFlowTypeId);
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.Approvers != null) {
this.Approvers = new FlowCreateApprover[source.Approvers.length];
for (int i = 0; i < source.Approvers.length; i++) {
this.Approvers[i] = new FlowCreateApprover(source.Approvers[i]);
}
}
if (source.IntelligentStatus != null) {
this.IntelligentStatus = new String(source.IntelligentStatus);
}
if (source.Components != null) {
this.Components = new Component(source.Components);
}
if (source.FlowOption != null) {
this.FlowOption = new CreateFlowOption(source.FlowOption);
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.NeedCreateReview != null) {
this.NeedCreateReview = new Boolean(source.NeedCreateReview);
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
if (source.CcInfos != null) {
this.CcInfos = new CcInfo(source.CcInfos);
}
if (source.FlowId != null) {
this.FlowId = new String(source.FlowId);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.InitiatorComponents != null) {
this.InitiatorComponents = new Component[source.InitiatorComponents.length];
for (int i = 0; i < source.InitiatorComponents.length; i++) {
this.InitiatorComponents[i] = new Component(source.InitiatorComponents[i]);
}
}
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.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "ResourceId", this.ResourceId);
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamSimple(map, prefix + "ResourceType", this.ResourceType);
this.setParamSimple(map, prefix + "Unordered", this.Unordered);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "UserFlowTypeId", this.UserFlowTypeId);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamArrayObj(map, prefix + "Approvers.", this.Approvers);
this.setParamSimple(map, prefix + "IntelligentStatus", this.IntelligentStatus);
this.setParamObj(map, prefix + "Components.", this.Components);
this.setParamObj(map, prefix + "FlowOption.", this.FlowOption);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "NeedCreateReview", this.NeedCreateReview);
this.setParamSimple(map, prefix + "UserData", this.UserData);
this.setParamObj(map, prefix + "CcInfos.", this.CcInfos);
this.setParamSimple(map, prefix + "FlowId", this.FlowId);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamArrayObj(map, prefix + "InitiatorComponents.", this.InitiatorComponents);
this.setParamSimple(map, prefix + "FlowDisplayType", this.FlowDisplayType);
}
}