com.tencentcloudapi.essbasic.v20210526.models

Class ChannelCreatePrepareFlowRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.ChannelCreatePrepareFlowRequest

public class ChannelCreatePrepareFlowRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ChannelCreatePrepareFlowRequest()
ChannelCreatePrepareFlowRequest(ChannelCreatePrepareFlowRequest source) 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.

Method Summary

Modifier and Type	Method and Description
Agent	getAgent() Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
CommonFlowApprover[]	getFlowApproverList() Get 合同签署人信息
String	getFlowId() Get 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
BaseFlowInfo	getFlowInfo() Get 要创建的合同信息
CreateFlowOption	getFlowOption() Get 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
Boolean	getNeedPreview() Deprecated.
UserInfo	getOperator() Deprecated.
OrganizationInfo	getOrganization() Deprecated.
String	getResourceId() Get 资源id，与ResourceType相对应，取值范围： 文件Id（通过UploadFiles获取文件资源Id） 模板Id（通过控制台创建模板后获取模板Id） 注意：需要同时设置 ResourceType 参数指定资源类型
Long	getResourceType() Get 资源类型，取值有： **1**：模板 **2**：文件（默认值）
void	setAgent(Agent Agent) Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
void	setFlowApproverList(CommonFlowApprover[] FlowApproverList) Set 合同签署人信息
void	setFlowId(String FlowId) Set 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
void	setFlowInfo(BaseFlowInfo FlowInfo) Set 要创建的合同信息
void	setFlowOption(CreateFlowOption FlowOption) Set 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
void	setNeedPreview(Boolean NeedPreview) Deprecated.
void	setOperator(UserInfo Operator) Deprecated.
void	setOrganization(OrganizationInfo Organization) Deprecated.
void	setResourceId(String ResourceId) Set 资源id，与ResourceType相对应，取值范围： 文件Id（通过UploadFiles获取文件资源Id） 模板Id（通过控制台创建模板后获取模板Id） 注意：需要同时设置 ResourceType 参数指定资源类型
void	setResourceType(Long ResourceType) Set 资源类型，取值有： **1**：模板 **2**：文件（默认值）
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelCreatePrepareFlowRequest

public ChannelCreatePrepareFlowRequest()

ChannelCreatePrepareFlowRequest

public ChannelCreatePrepareFlowRequest(ChannelCreatePrepareFlowRequest source)

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.

Method Detail

getResourceType

public Long getResourceType()

Get 资源类型，取值有：

• **1**：模板
• **2**：文件（默认值）

Returns:

ResourceType 资源类型，取值有：

• **1**：模板
• **2**：文件（默认值）

setResourceType

public void setResourceType(Long ResourceType)

Set 资源类型，取值有：

• **1**：模板
• **2**：文件（默认值）

Parameters:

ResourceType - 资源类型，取值有：

• **1**：模板
• **2**：文件（默认值）

getFlowInfo

public BaseFlowInfo getFlowInfo()

Get 要创建的合同信息

Returns:

FlowInfo 要创建的合同信息

setFlowInfo

public void setFlowInfo(BaseFlowInfo FlowInfo)

Set 要创建的合同信息

Parameters:

FlowInfo - 要创建的合同信息

getAgent

public Agent getAgent()

Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

Returns:

Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

setAgent

public void setAgent(Agent Agent)

Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

Parameters:

Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。

• 渠道应用标识: Agent.AppId
• 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
• 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId

第三方平台子客企业和员工必须已经经过实名认证

getResourceId

public String getResourceId()

Get 资源id，与ResourceType相对应，取值范围：

• 文件Id（通过UploadFiles获取文件资源Id）
• 模板Id（通过控制台创建模板后获取模板Id）

注意：需要同时设置 ResourceType 参数指定资源类型

Returns:

ResourceId 资源id，与ResourceType相对应，取值范围：

• 文件Id（通过UploadFiles获取文件资源Id）
• 模板Id（通过控制台创建模板后获取模板Id）

注意：需要同时设置 ResourceType 参数指定资源类型

setResourceId

public void setResourceId(String ResourceId)

Set 资源id，与ResourceType相对应，取值范围：

• 文件Id（通过UploadFiles获取文件资源Id）
• 模板Id（通过控制台创建模板后获取模板Id）

注意：需要同时设置 ResourceType 参数指定资源类型

Parameters:

ResourceId - 资源id，与ResourceType相对应，取值范围：

• 文件Id（通过UploadFiles获取文件资源Id）
• 模板Id（通过控制台创建模板后获取模板Id）

注意：需要同时设置 ResourceType 参数指定资源类型

getFlowOption

public CreateFlowOption getFlowOption()

Get 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑

Returns:

FlowOption 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑

setFlowOption

public void setFlowOption(CreateFlowOption FlowOption)

Set 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑

Parameters:

FlowOption - 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑

getFlowApproverList

public CommonFlowApprover[] getFlowApproverList()

Get 合同签署人信息

Returns:

FlowApproverList 合同签署人信息

setFlowApproverList

public void setFlowApproverList(CommonFlowApprover[] FlowApproverList)

Set 合同签署人信息

Parameters:

FlowApproverList - 合同签署人信息

getFlowId

public String getFlowId()

Get 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`

Returns:

FlowId 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`

setFlowId

public void setFlowId(String FlowId)

Set 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`

Parameters:

FlowId - 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`

getNeedPreview

@Deprecated
public Boolean getNeedPreview()

Deprecated.

Get 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL

Returns:

NeedPreview 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL

setNeedPreview

@Deprecated
public void setNeedPreview(Boolean NeedPreview)

Deprecated.

Set 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL

Parameters:

NeedPreview - 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL

getOrganization

@Deprecated
public OrganizationInfo getOrganization()

Deprecated.

Get 企业机构信息，不用传

Returns:

Organization 企业机构信息，不用传

setOrganization

@Deprecated
public void setOrganization(OrganizationInfo Organization)

Deprecated.

Set 企业机构信息，不用传

Parameters:

Organization - 企业机构信息，不用传

getOperator

@Deprecated
public UserInfo getOperator()

Deprecated.

Get 操作人（用户）信息，不用传

Returns:

Operator 操作人（用户）信息，不用传

setOperator

@Deprecated
public void setOperator(UserInfo Operator)

Deprecated.

Set 操作人（用户）信息，不用传

Parameters:

Operator - 操作人（用户）信息，不用传

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel