com.tencentcloudapi.essbasic.v20210526.models

Class FlowInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.FlowInfo

public class FlowInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
FlowInfo()
FlowInfo(FlowInfo 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
String	getAutoSignScene() Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
String	getCallbackUrl() Get 回调地址，最大长度1000个字符
CcInfo[]	getCcInfos() Get 被抄送人的信息列表，抄送功能暂不开放
Long	getCcNotifyType() Get 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
String	getCustomerData() Get 第三方应用平台的业务信息，最大长度1000个字符。
String	getCustomShowMap() Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
Long	getDeadline() Get 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
FlowApproverInfo[]	getFlowApprovers() Get 多个签署人信息，最大支持50个签署方
String	getFlowDescription() Get 合同描述，最大长度1000个字符
String	getFlowName() Get 合同名字，最大长度200个字符
String	getFlowType() Get 合同类型，如：1.
FormField[]	getFormFields() Get 表单K-V对列表
Boolean	getNeedSignReview() Get 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
String	getTemplateId() Get 模板ID
void	setAutoSignScene(String AutoSignScene) Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
void	setCallbackUrl(String CallbackUrl) Set 回调地址，最大长度1000个字符
void	setCcInfos(CcInfo[] CcInfos) Set 被抄送人的信息列表，抄送功能暂不开放
void	setCcNotifyType(Long CcNotifyType) Set 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
void	setCustomerData(String CustomerData) Set 第三方应用平台的业务信息，最大长度1000个字符。
void	setCustomShowMap(String CustomShowMap) Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
void	setDeadline(Long Deadline) Set 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
void	setFlowApprovers(FlowApproverInfo[] FlowApprovers) Set 多个签署人信息，最大支持50个签署方
void	setFlowDescription(String FlowDescription) Set 合同描述，最大长度1000个字符
void	setFlowName(String FlowName) Set 合同名字，最大长度200个字符
void	setFlowType(String FlowType) Set 合同类型，如：1.
void	setFormFields(FormField[] FormFields) Set 表单K-V对列表
void	setNeedSignReview(Boolean NeedSignReview) Set 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
void	setTemplateId(String TemplateId) Set 模板ID
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, getSkipSign, set, 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

FlowInfo

public FlowInfo()

FlowInfo

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

getFlowName

public String getFlowName()

Get 合同名字，最大长度200个字符

Returns:

FlowName 合同名字，最大长度200个字符

setFlowName

public void setFlowName(String FlowName)

Set 合同名字，最大长度200个字符

Parameters:

FlowName - 合同名字，最大长度200个字符

getDeadline

public Long getDeadline()

Get 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年

Returns:

Deadline 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年

setDeadline

public void setDeadline(Long Deadline)

Set 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年

Parameters:

Deadline - 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年

getTemplateId

public String getTemplateId()

Get 模板ID

Returns:

TemplateId 模板ID

setTemplateId

public void setTemplateId(String TemplateId)

Set 模板ID

Parameters:

TemplateId - 模板ID

getFlowApprovers

public FlowApproverInfo[] getFlowApprovers()

Get 多个签署人信息，最大支持50个签署方

Returns:

FlowApprovers 多个签署人信息，最大支持50个签署方

setFlowApprovers

public void setFlowApprovers(FlowApproverInfo[] FlowApprovers)

Set 多个签署人信息，最大支持50个签署方

Parameters:

FlowApprovers - 多个签署人信息，最大支持50个签署方

getFormFields

public FormField[] getFormFields()

Get 表单K-V对列表

Returns:

FormFields 表单K-V对列表

setFormFields

public void setFormFields(FormField[] FormFields)

Set 表单K-V对列表

Parameters:

FormFields - 表单K-V对列表

getCallbackUrl

public String getCallbackUrl()

Get 回调地址，最大长度1000个字符

Returns:

CallbackUrl 回调地址，最大长度1000个字符

setCallbackUrl

public void setCallbackUrl(String CallbackUrl)

Set 回调地址，最大长度1000个字符

Parameters:

CallbackUrl - 回调地址，最大长度1000个字符

getFlowType

public String getFlowType()

Get 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符

Returns:

FlowType 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符

setFlowType

public void setFlowType(String FlowType)

Set 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符

Parameters:

FlowType - 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符

getFlowDescription

public String getFlowDescription()

Get 合同描述，最大长度1000个字符

Returns:

FlowDescription 合同描述，最大长度1000个字符

setFlowDescription

public void setFlowDescription(String FlowDescription)

Set 合同描述，最大长度1000个字符

Parameters:

FlowDescription - 合同描述，最大长度1000个字符

getCustomerData

public String getCustomerData()

Get 第三方应用平台的业务信息，最大长度1000个字符。

Returns:

CustomerData 第三方应用平台的业务信息，最大长度1000个字符。

setCustomerData

public void setCustomerData(String CustomerData)

Set 第三方应用平台的业务信息，最大长度1000个字符。

Parameters:

CustomerData - 第三方应用平台的业务信息，最大长度1000个字符。

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开始

getCcInfos

public CcInfo[] getCcInfos()

Get 被抄送人的信息列表，抄送功能暂不开放

Returns:

CcInfos 被抄送人的信息列表，抄送功能暂不开放

setCcInfos

public void setCcInfos(CcInfo[] CcInfos)

Set 被抄送人的信息列表，抄送功能暂不开放

Parameters:

CcInfos - 被抄送人的信息列表，抄送功能暂不开放

getNeedSignReview

public Boolean getNeedSignReview()

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

Returns:

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

setNeedSignReview

public void setNeedSignReview(Boolean NeedSignReview)

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

Parameters:

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

getCcNotifyType

public Long getCcNotifyType()

Get 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知

Returns:

CcNotifyType 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知

setCcNotifyType

public void setCcNotifyType(Long CcNotifyType)

Set 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知

Parameters:

CcNotifyType - 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知

getAutoSignScene

public String getAutoSignScene()

Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN

Returns:

AutoSignScene 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN

setAutoSignScene

public void setAutoSignScene(String AutoSignScene)

Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN

Parameters:

AutoSignScene - 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel