com.tencentcloudapi.essbasic.v20201222.models

Class SendFlowRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20201222.models.SendFlowRequest

public class SendFlowRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SendFlowRequest()
SendFlowRequest(SendFlowRequest 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	getCallbackUrl() Get 签署任务的回调地址
Caller	getCaller() Get 调用方信息
Boolean	getCanOffLine() Get 当前参与者是否支持线下核身,默认为不支持
Long	getDeadline() Get 签署链接失效截止时间，默认为7天
String	getFlowId() Get 需要推送合同的流程ID
Boolean	getIsFullText() Get 签署前置条件：是否要全文阅读，默认否
Boolean	getIsLastApprover() Get 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。
String	getJumpUrl() Get 签署完成后，前端跳转的URL
String	getMobile() Get 签署人手机号 (如果选择短信验证码签署，则此字段必填)
Long	getPreReadTime() Get 签署前置条件：强制用户阅读待签署文件时长，默认不限制
Component[]	getSignComponents() Get 签署控件信息 (支持添加多个控件)
SmsTemplate	getSmsTemplate() Get 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。
String	getSubOrganizationId() Get 签署人对应的子机构ID，个人签署者此字段不填
String	getUserId() Get 签署人用户ID
String[]	getVerifyChannel() Get 签名后校验方式： 1.
void	setCallbackUrl(String CallbackUrl) Set 签署任务的回调地址
void	setCaller(Caller Caller) Set 调用方信息
void	setCanOffLine(Boolean CanOffLine) Set 当前参与者是否支持线下核身,默认为不支持
void	setDeadline(Long Deadline) Set 签署链接失效截止时间，默认为7天
void	setFlowId(String FlowId) Set 需要推送合同的流程ID
void	setIsFullText(Boolean IsFullText) Set 签署前置条件：是否要全文阅读，默认否
void	setIsLastApprover(Boolean IsLastApprover) Set 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。
void	setJumpUrl(String JumpUrl) Set 签署完成后，前端跳转的URL
void	setMobile(String Mobile) Set 签署人手机号 (如果选择短信验证码签署，则此字段必填)
void	setPreReadTime(Long PreReadTime) Set 签署前置条件：强制用户阅读待签署文件时长，默认不限制
void	setSignComponents(Component[] SignComponents) Set 签署控件信息 (支持添加多个控件)
void	setSmsTemplate(SmsTemplate SmsTemplate) Set 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。
void	setSubOrganizationId(String SubOrganizationId) Set 签署人对应的子机构ID，个人签署者此字段不填
void	setUserId(String UserId) Set 签署人用户ID
void	setVerifyChannel(String[] VerifyChannel) Set 签名后校验方式： 1.
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

SendFlowRequest

public SendFlowRequest()

SendFlowRequest

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

getCaller

public Caller getCaller()

Get 调用方信息

Returns:

Caller 调用方信息

setCaller

public void setCaller(Caller Caller)

Set 调用方信息

Parameters:

Caller - 调用方信息

getFlowId

public String getFlowId()

Get 需要推送合同的流程ID

Returns:

FlowId 需要推送合同的流程ID

setFlowId

public void setFlowId(String FlowId)

Set 需要推送合同的流程ID

Parameters:

FlowId - 需要推送合同的流程ID

getUserId

public String getUserId()

Get 签署人用户ID

Returns:

UserId 签署人用户ID

setUserId

public void setUserId(String UserId)

Set 签署人用户ID

Parameters:

UserId - 签署人用户ID

getSignComponents

public Component[] getSignComponents()

Get 签署控件信息 (支持添加多个控件)

Returns:

SignComponents 签署控件信息 (支持添加多个控件)

setSignComponents

public void setSignComponents(Component[] SignComponents)

Set 签署控件信息 (支持添加多个控件)

Parameters:

SignComponents - 签署控件信息 (支持添加多个控件)

getMobile

public String getMobile()

Get 签署人手机号 (如果选择短信验证码签署，则此字段必填)

Returns:

Mobile 签署人手机号 (如果选择短信验证码签署，则此字段必填)

setMobile

public void setMobile(String Mobile)

Set 签署人手机号 (如果选择短信验证码签署，则此字段必填)

Parameters:

Mobile - 签署人手机号 (如果选择短信验证码签署，则此字段必填)

getSubOrganizationId

public String getSubOrganizationId()

Get 签署人对应的子机构ID，个人签署者此字段不填

Returns:

SubOrganizationId 签署人对应的子机构ID，个人签署者此字段不填

setSubOrganizationId

public void setSubOrganizationId(String SubOrganizationId)

Set 签署人对应的子机构ID，个人签署者此字段不填

Parameters:

SubOrganizationId - 签署人对应的子机构ID，个人签署者此字段不填

getVerifyChannel

public String[] getVerifyChannel()

Get 签名后校验方式： 1. WEIXINAPP - 微信小程序； 2. FACEID - 慧眼 (默认) ； 3. VERIFYCODE - 验证码； 4. NONE - 无。此选项为白名单参数，暂不支持公开调用。如需开通权限，请通过客户经理或邮件至[email protected]与我们联系； 5. THIRD - 第三方 (暂不支持)

Returns:

VerifyChannel 签名后校验方式： 1. WEIXINAPP - 微信小程序； 2. FACEID - 慧眼 (默认) ； 3. VERIFYCODE - 验证码； 4. NONE - 无。此选项为白名单参数，暂不支持公开调用。如需开通权限，请通过客户经理或邮件至[email protected]与我们联系； 5. THIRD - 第三方 (暂不支持)

setVerifyChannel

public void setVerifyChannel(String[] VerifyChannel)

Set 签名后校验方式： 1. WEIXINAPP - 微信小程序； 2. FACEID - 慧眼 (默认) ； 3. VERIFYCODE - 验证码； 4. NONE - 无。此选项为白名单参数，暂不支持公开调用。如需开通权限，请通过客户经理或邮件至[email protected]与我们联系； 5. THIRD - 第三方 (暂不支持)

Parameters:

VerifyChannel - 签名后校验方式： 1. WEIXINAPP - 微信小程序； 2. FACEID - 慧眼 (默认) ； 3. VERIFYCODE - 验证码； 4. NONE - 无。此选项为白名单参数，暂不支持公开调用。如需开通权限，请通过客户经理或邮件至[email protected]与我们联系； 5. THIRD - 第三方 (暂不支持)

getDeadline

public Long getDeadline()

Get 签署链接失效截止时间，默认为7天

Returns:

Deadline 签署链接失效截止时间，默认为7天

setDeadline

public void setDeadline(Long Deadline)

Set 签署链接失效截止时间，默认为7天

Parameters:

Deadline - 签署链接失效截止时间，默认为7天

getIsLastApprover

public Boolean getIsLastApprover()

Get 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。

Returns:

IsLastApprover 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。

setIsLastApprover

public void setIsLastApprover(Boolean IsLastApprover)

Set 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。

Parameters:

IsLastApprover - 是否为最后一个签署人。若为最后一人，本次签署完成以后自动归档。

getJumpUrl

public String getJumpUrl()

Get 签署完成后，前端跳转的URL

Returns:

JumpUrl 签署完成后，前端跳转的URL

setJumpUrl

public void setJumpUrl(String JumpUrl)

Set 签署完成后，前端跳转的URL

Parameters:

JumpUrl - 签署完成后，前端跳转的URL

getSmsTemplate

public SmsTemplate getSmsTemplate()

Get 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。

Returns:

SmsTemplate 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。

setSmsTemplate

public void setSmsTemplate(SmsTemplate SmsTemplate)

Set 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。

Parameters:

SmsTemplate - 短信模板。默认使用腾讯电子签官方短信模板，如有自定义需求，请通过客户经理或邮件至[email protected]与我们联系。

getIsFullText

public Boolean getIsFullText()

Get 签署前置条件：是否要全文阅读，默认否

Returns:

IsFullText 签署前置条件：是否要全文阅读，默认否

setIsFullText

public void setIsFullText(Boolean IsFullText)

Set 签署前置条件：是否要全文阅读，默认否

Parameters:

IsFullText - 签署前置条件：是否要全文阅读，默认否

getPreReadTime

public Long getPreReadTime()

Get 签署前置条件：强制用户阅读待签署文件时长，默认不限制

Returns:

PreReadTime 签署前置条件：强制用户阅读待签署文件时长，默认不限制

setPreReadTime

public void setPreReadTime(Long PreReadTime)

Set 签署前置条件：强制用户阅读待签署文件时长，默认不限制

Parameters:

PreReadTime - 签署前置条件：强制用户阅读待签署文件时长，默认不限制

getCanOffLine

public Boolean getCanOffLine()

Get 当前参与者是否支持线下核身,默认为不支持

Returns:

CanOffLine 当前参与者是否支持线下核身,默认为不支持

setCanOffLine

public void setCanOffLine(Boolean CanOffLine)

Set 当前参与者是否支持线下核身,默认为不支持

Parameters:

CanOffLine - 当前参与者是否支持线下核身,默认为不支持

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