com.tencentcloudapi.ess.v20201111.models.CreateFlowSignUrlRequest 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 CreateFlowSignUrlRequest extends AbstractModel {
/**
* 合同流程ID为32位字符串。
您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
*/
@SerializedName("FlowId")
@Expose
private String FlowId;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
注：
1. 签署人只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时不支持。
2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
*/
@SerializedName("FlowApproverInfos")
@Expose
private FlowCreateApprover [] FlowApproverInfos;
/**
* 机构信息，暂未开放
*/
@SerializedName("Organization")
@Expose
private OrganizationInfo Organization;
/**
* 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5
*/
@SerializedName("JumpUrl")
@Expose
private String JumpUrl;
/**
* 链接类型支持以下指定类型：
- 0: 签署链接（默认值），进入后可以填写或签署合同。
- 1 : 预览链接，进入后可以预览合同当前的样子。
注：
1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
*/
@SerializedName("UrlType")
@Expose
private Long UrlType;
/**
* Get 合同流程ID为32位字符串。
您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
* @return FlowId 合同流程ID为32位字符串。
您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
*/
public String getFlowId() {
return this.FlowId;
}
/**
* Set 合同流程ID为32位字符串。
您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
* @param FlowId 合同流程ID为32位字符串。
您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
*/
public void setFlowId(String FlowId) {
this.FlowId = FlowId;
}
/**
* Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* 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 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
注：
1. 签署人只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时不支持。
2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
* @return FlowApproverInfos 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
注：
1. 签署人只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时不支持。
2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
*/
public FlowCreateApprover [] getFlowApproverInfos() {
return this.FlowApproverInfos;
}
/**
* Set 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
注：
1. 签署人只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时不支持。
2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
* @param FlowApproverInfos 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
注：
1. 签署人只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时不支持。
2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
*/
public void setFlowApproverInfos(FlowCreateApprover [] FlowApproverInfos) {
this.FlowApproverInfos = FlowApproverInfos;
}
/**
* Get 机构信息，暂未开放
* @return Organization 机构信息，暂未开放
* @deprecated
*/
@Deprecated
public OrganizationInfo getOrganization() {
return this.Organization;
}
/**
* Set 机构信息，暂未开放
* @param Organization 机构信息，暂未开放
* @deprecated
*/
@Deprecated
public void setOrganization(OrganizationInfo Organization) {
this.Organization = Organization;
}
/**
* Get 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5
* @return JumpUrl 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5
*/
public String getJumpUrl() {
return this.JumpUrl;
}
/**
* Set 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5
* @param JumpUrl 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5
*/
public void setJumpUrl(String JumpUrl) {
this.JumpUrl = JumpUrl;
}
/**
* Get 链接类型支持以下指定类型：
- 0: 签署链接（默认值），进入后可以填写或签署合同。
- 1 : 预览链接，进入后可以预览合同当前的样子。
注：
1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
* @return UrlType 链接类型支持以下指定类型：
- 0: 签署链接（默认值），进入后可以填写或签署合同。
- 1 : 预览链接，进入后可以预览合同当前的样子。
注：
1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
*/
public Long getUrlType() {
return this.UrlType;
}
/**
* Set 链接类型支持以下指定类型：
- 0: 签署链接（默认值），进入后可以填写或签署合同。
- 1 : 预览链接，进入后可以预览合同当前的样子。
注：
1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
* @param UrlType 链接类型支持以下指定类型：
- 0: 签署链接（默认值），进入后可以填写或签署合同。
- 1 : 预览链接，进入后可以预览合同当前的样子。
注：
1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
*/
public void setUrlType(Long UrlType) {
this.UrlType = UrlType;
}
public CreateFlowSignUrlRequest() {
}
/**
* 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 CreateFlowSignUrlRequest(CreateFlowSignUrlRequest source) {
if (source.FlowId != null) {
this.FlowId = new String(source.FlowId);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.FlowApproverInfos != null) {
this.FlowApproverInfos = new FlowCreateApprover[source.FlowApproverInfos.length];
for (int i = 0; i < source.FlowApproverInfos.length; i++) {
this.FlowApproverInfos[i] = new FlowCreateApprover(source.FlowApproverInfos[i]);
}
}
if (source.Organization != null) {
this.Organization = new OrganizationInfo(source.Organization);
}
if (source.JumpUrl != null) {
this.JumpUrl = new String(source.JumpUrl);
}
if (source.UrlType != null) {
this.UrlType = new Long(source.UrlType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "FlowId", this.FlowId);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamArrayObj(map, prefix + "FlowApproverInfos.", this.FlowApproverInfos);
this.setParamObj(map, prefix + "Organization.", this.Organization);
this.setParamSimple(map, prefix + "JumpUrl", this.JumpUrl);
this.setParamSimple(map, prefix + "UrlType", this.UrlType);
}
}