com.tencentcloudapi.essbasic.v20210526.models.CreateFlowsByTemplatesRequest 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 CreateFlowsByTemplatesRequest extends AbstractModel {
/**
* 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 要创建的合同信息列表，最多支持一次创建20个合同
*/
@SerializedName("FlowInfos")
@Expose
private FlowInfo [] FlowInfos;
/**
* 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
*/
@SerializedName("NeedPreview")
@Expose
private Boolean NeedPreview;
/**
* 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
@SerializedName("PreviewType")
@Expose
private Long PreviewType;
/**
* 操作者的信息，不用传
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 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 要创建的合同信息列表，最多支持一次创建20个合同
* @return FlowInfos 要创建的合同信息列表，最多支持一次创建20个合同
*/
public FlowInfo [] getFlowInfos() {
return this.FlowInfos;
}
/**
* Set 要创建的合同信息列表，最多支持一次创建20个合同
* @param FlowInfos 要创建的合同信息列表，最多支持一次创建20个合同
*/
public void setFlowInfos(FlowInfo [] FlowInfos) {
this.FlowInfos = FlowInfos;
}
/**
* Get 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
* @return NeedPreview 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
*/
public Boolean getNeedPreview() {
return this.NeedPreview;
}
/**
* Set 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
* @param NeedPreview 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
*/
public void setNeedPreview(Boolean NeedPreview) {
this.NeedPreview = NeedPreview;
}
/**
* Get 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
* @return PreviewType 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
public Long getPreviewType() {
return this.PreviewType;
}
/**
* Set 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
* @param PreviewType 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
public void setPreviewType(Long PreviewType) {
this.PreviewType = PreviewType;
}
/**
* Get 操作者的信息，不用传
* @return Operator 操作者的信息，不用传
* @deprecated
*/
@Deprecated
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 操作者的信息，不用传
* @param Operator 操作者的信息，不用传
* @deprecated
*/
@Deprecated
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
public CreateFlowsByTemplatesRequest() {
}
/**
* 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 CreateFlowsByTemplatesRequest(CreateFlowsByTemplatesRequest source) {
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.FlowInfos != null) {
this.FlowInfos = new FlowInfo[source.FlowInfos.length];
for (int i = 0; i < source.FlowInfos.length; i++) {
this.FlowInfos[i] = new FlowInfo(source.FlowInfos[i]);
}
}
if (source.NeedPreview != null) {
this.NeedPreview = new Boolean(source.NeedPreview);
}
if (source.PreviewType != null) {
this.PreviewType = new Long(source.PreviewType);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamArrayObj(map, prefix + "FlowInfos.", this.FlowInfos);
this.setParamSimple(map, prefix + "NeedPreview", this.NeedPreview);
this.setParamSimple(map, prefix + "PreviewType", this.PreviewType);
this.setParamObj(map, prefix + "Operator.", this.Operator);
}
}