com.tencentcloudapi.ess.v20201111.models

Class CreateFlowRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateFlowRequest

public class CreateFlowRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateFlowRequest()
CreateFlowRequest(CreateFlowRequest 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 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
FlowCreateApprover[]	getApprovers() Get 签署流程参与者信息，最大限制50方
String	getCallbackUrl() Get 暂未开放
CcInfo[]	getCcInfos() Get 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。
String	getClientToken() Get 客户端Token，保持接口幂等性,最大长度64个字符
String	getCustomShowMap() Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
Long	getDeadLine() Get 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后
String	getFlowDescription() Get 签署流程描述,最大长度1000个字符
String	getFlowName() Get 签署流程名称,最大长度200个字符
String	getFlowType() Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
Boolean	getNeedSignReview() Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
UserInfo	getOperator() Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
String	getRelatedFlowId() Get 暂未开放
Boolean	getUnordered() Get 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致
String	getUserData() Get 用户自定义字段，回调的时候会进行透传，长度需要小于20480
void	setAgent(Agent Agent) Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
void	setApprovers(FlowCreateApprover[] Approvers) Set 签署流程参与者信息，最大限制50方
void	setCallbackUrl(String CallbackUrl) Set 暂未开放
void	setCcInfos(CcInfo[] CcInfos) Set 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。
void	setClientToken(String ClientToken) Set 客户端Token，保持接口幂等性,最大长度64个字符
void	setCustomShowMap(String CustomShowMap) Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
void	setDeadLine(Long DeadLine) Set 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后
void	setFlowDescription(String FlowDescription) Set 签署流程描述,最大长度1000个字符
void	setFlowName(String FlowName) Set 签署流程名称,最大长度200个字符
void	setFlowType(String FlowType) Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
void	setNeedSignReview(Boolean NeedSignReview) Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
void	setOperator(UserInfo Operator) Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
void	setRelatedFlowId(String RelatedFlowId) Set 暂未开放
void	setUnordered(Boolean Unordered) Set 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致
void	setUserData(String UserData) Set 用户自定义字段，回调的时候会进行透传，长度需要小于20480
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateFlowRequest

public CreateFlowRequest()

CreateFlowRequest

public CreateFlowRequest(CreateFlowRequest 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

getOperator

public UserInfo getOperator()

Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

Returns:

Operator 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

setOperator

public void setOperator(UserInfo Operator)

Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

Parameters:

Operator - 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。

getFlowName

public String getFlowName()

Get 签署流程名称,最大长度200个字符

Returns:

FlowName 签署流程名称,最大长度200个字符

setFlowName

public void setFlowName(String FlowName)

Set 签署流程名称,最大长度200个字符

Parameters:

FlowName - 签署流程名称,最大长度200个字符

getApprovers

public FlowCreateApprover[] getApprovers()

Get 签署流程参与者信息，最大限制50方

Returns:

Approvers 签署流程参与者信息，最大限制50方

setApprovers

public void setApprovers(FlowCreateApprover[] Approvers)

Set 签署流程参与者信息，最大限制50方

Parameters:

Approvers - 签署流程参与者信息，最大限制50方

getFlowType

public String getFlowType()

Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

Returns:

FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

setFlowType

public void setFlowType(String FlowType)

Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

Parameters:

FlowType - 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

getClientToken

public String getClientToken()

Get 客户端Token，保持接口幂等性,最大长度64个字符

Returns:

ClientToken 客户端Token，保持接口幂等性,最大长度64个字符

setClientToken

public void setClientToken(String ClientToken)

Set 客户端Token，保持接口幂等性,最大长度64个字符

Parameters:

ClientToken - 客户端Token，保持接口幂等性,最大长度64个字符

getRelatedFlowId

public String getRelatedFlowId()

Get 暂未开放

Returns:

RelatedFlowId 暂未开放

setRelatedFlowId

public void setRelatedFlowId(String RelatedFlowId)

Set 暂未开放

Parameters:

RelatedFlowId - 暂未开放

getDeadLine

public Long getDeadLine()

Get 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后

Returns:

DeadLine 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后

setDeadLine

public void setDeadLine(Long DeadLine)

Set 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后

Parameters:

DeadLine - 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后

getUserData

public String getUserData()

Get 用户自定义字段，回调的时候会进行透传，长度需要小于20480

Returns:

UserData 用户自定义字段，回调的时候会进行透传，长度需要小于20480

setUserData

public void setUserData(String UserData)

Set 用户自定义字段，回调的时候会进行透传，长度需要小于20480

Parameters:

UserData - 用户自定义字段，回调的时候会进行透传，长度需要小于20480

getFlowDescription

public String getFlowDescription()

Get 签署流程描述,最大长度1000个字符

Returns:

FlowDescription 签署流程描述,最大长度1000个字符

setFlowDescription

public void setFlowDescription(String FlowDescription)

Set 签署流程描述,最大长度1000个字符

Parameters:

FlowDescription - 签署流程描述,最大长度1000个字符

getUnordered

public Boolean getUnordered()

Get 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致

Returns:

Unordered 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致

setUnordered

public void setUnordered(Boolean Unordered)

Set 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致

Parameters:

Unordered - 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致

getCustomShowMap

public String getCustomShowMap()

Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始

Returns:

CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始

setCustomShowMap

public void setCustomShowMap(String CustomShowMap)

Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始

Parameters:

CustomShowMap - 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始

getNeedSignReview

public Boolean getNeedSignReview()

Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。

Returns:

NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。

setNeedSignReview

public void setNeedSignReview(Boolean NeedSignReview)

Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。

Parameters:

NeedSignReview - 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。

getCallbackUrl

public String getCallbackUrl()

Get 暂未开放

Returns:

CallbackUrl 暂未开放

setCallbackUrl

public void setCallbackUrl(String CallbackUrl)

Set 暂未开放

Parameters:

CallbackUrl - 暂未开放

getAgent

public Agent getAgent()

Get 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Returns:

Agent 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

setAgent

public void setAgent(Agent Agent)

Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Parameters:

Agent - 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

getCcInfos

public CcInfo[] getCcInfos()

Get 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。

Returns:

CcInfos 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。

setCcInfos

public void setCcInfos(CcInfo[] CcInfos)

Set 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。

Parameters:

CcInfos - 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel