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 应用相关信息
FlowCreateApprover[]	getApprovers() Get 签署流程参与者信息
String	getCallbackUrl() 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个字符
UserInfo	getOperator() Get 操作人信息
String	getRelatedFlowId() Get 暂未开放
Boolean	getUnordered() Get 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致
String	getUserData() Get 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于20480
void	setAgent(Agent Agent) Set 应用相关信息
void	setApprovers(FlowCreateApprover[] Approvers) Set 签署流程参与者信息
void	setCallbackUrl(String CallbackUrl) 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	setOperator(UserInfo Operator) Set 操作人信息
void	setRelatedFlowId(String RelatedFlowId) Set 暂未开放
void	setUnordered(Boolean Unordered) Set 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致
void	setUserData(String UserData) Set 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于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

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 签署流程参与者信息

Returns:

Approvers 签署流程参与者信息

setApprovers

public void setApprovers(FlowCreateApprover[] Approvers)

Set 签署流程参与者信息

Parameters:

Approvers - 签署流程参与者信息

getOperator

public UserInfo getOperator()

Get 操作人信息

Returns:

Operator 操作人信息

setOperator

public void setOperator(UserInfo Operator)

Set 操作人信息

Parameters:

Operator - 操作人信息

getAgent

public Agent getAgent()

Get 应用相关信息

Returns:

Agent 应用相关信息

setAgent

public void setAgent(Agent Agent)

Set 应用相关信息

Parameters:

Agent - 应用相关信息

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（有序签），请和模板中的配置保持一致

getDeadLine

public Long getDeadLine()

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

Returns:

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

setDeadLine

public void setDeadLine(Long DeadLine)

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

Parameters:

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

getFlowType

public String getFlowType()

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

Returns:

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

setFlowType

public void setFlowType(String FlowType)

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

Parameters:

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

getUserData

public String getUserData()

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

Returns:

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

setUserData

public void setUserData(String UserData)

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

Parameters:

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

getFlowDescription

public String getFlowDescription()

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

Returns:

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

setFlowDescription

public void setFlowDescription(String FlowDescription)

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

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

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

setClientToken

public void setClientToken(String ClientToken)

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

Parameters:

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

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

getRelatedFlowId

public String getRelatedFlowId()

Get 暂未开放

Returns:

RelatedFlowId 暂未开放

setRelatedFlowId

public void setRelatedFlowId(String RelatedFlowId)

Set 暂未开放

Parameters:

RelatedFlowId - 暂未开放

getCallbackUrl

public String getCallbackUrl()

Get 暂未开放

Returns:

CallbackUrl 暂未开放

setCallbackUrl

public void setCallbackUrl(String CallbackUrl)

Set 暂未开放

Parameters:

CallbackUrl - 暂未开放

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel