com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest 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 ChannelCreateFlowSignUrlRequest extends AbstractModel {
/**
* 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
@SerializedName("FlowId")
@Expose
private String FlowId;
/**
* 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
*/
@SerializedName("FlowApproverInfos")
@Expose
private FlowApproverInfo [] FlowApproverInfos;
/**
* 用户信息，暂未开放
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 机构信息，暂未开放
*/
@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 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
* @return Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
* @param Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
* @return FlowId 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
public String getFlowId() {
return this.FlowId;
}
/**
* Set 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
* @param FlowId 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
public void setFlowId(String FlowId) {
this.FlowId = FlowId;
}
/**
* Get 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
* @return FlowApproverInfos 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
*/
public FlowApproverInfo [] getFlowApproverInfos() {
return this.FlowApproverInfos;
}
/**
* Set 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
* @param FlowApproverInfos 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
*/
public void setFlowApproverInfos(FlowApproverInfo [] FlowApproverInfos) {
this.FlowApproverInfos = FlowApproverInfos;
}
/**
* Get 用户信息，暂未开放
* @return Operator 用户信息，暂未开放
* @deprecated
*/
@Deprecated
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 用户信息，暂未开放
* @param Operator 用户信息，暂未开放
* @deprecated
*/
@Deprecated
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* 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 ChannelCreateFlowSignUrlRequest() {
}
/**
* 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 ChannelCreateFlowSignUrlRequest(ChannelCreateFlowSignUrlRequest source) {
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.FlowId != null) {
this.FlowId = new String(source.FlowId);
}
if (source.FlowApproverInfos != null) {
this.FlowApproverInfos = new FlowApproverInfo[source.FlowApproverInfos.length];
for (int i = 0; i < source.FlowApproverInfos.length; i++) {
this.FlowApproverInfos[i] = new FlowApproverInfo(source.FlowApproverInfos[i]);
}
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
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.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "FlowId", this.FlowId);
this.setParamArrayObj(map, prefix + "FlowApproverInfos.", this.FlowApproverInfos);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamObj(map, prefix + "Organization.", this.Organization);
this.setParamSimple(map, prefix + "JumpUrl", this.JumpUrl);
this.setParamSimple(map, prefix + "UrlType", this.UrlType);
}
}