com.tencentcloudapi.essbasic.v20210526.models

Class CreateSignUrlsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.CreateSignUrlsRequest

public class CreateSignUrlsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateSignUrlsRequest()
CreateSignUrlsRequest(CreateSignUrlsRequest 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.ProxyOrganizationOpenId、Agent.
Boolean	getAutoJumpBack() Get Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序
String	getEndpoint() Get 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；
String[]	getFlowIds() Get 签署流程编号数组，最多支持100个。
String	getGenerateType() Get 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；
String	getJumpUrl() Get 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
String	getMobile() Get 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填
String	getName() Get 参与人姓名，GenerateType为"PERSON"时必填
String	getOpenId() Get 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人
UserInfo	getOperator() Get 操作者的信息
String	getOrganizationName() Get 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
String	getOrganizationOpenId() Get 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填
void	setAgent(Agent Agent) Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.
void	setAutoJumpBack(Boolean AutoJumpBack) Set Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序
void	setEndpoint(String Endpoint) Set 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；
void	setFlowIds(String[] FlowIds) Set 签署流程编号数组，最多支持100个。
void	setGenerateType(String GenerateType) Set 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；
void	setJumpUrl(String JumpUrl) Set 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
void	setMobile(String Mobile) Set 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填
void	setName(String Name) Set 参与人姓名，GenerateType为"PERSON"时必填
void	setOpenId(String OpenId) Set 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人
void	setOperator(UserInfo Operator) Set 操作者的信息
void	setOrganizationName(String OrganizationName) Set 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
void	setOrganizationOpenId(String OrganizationOpenId) Set 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填
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

CreateSignUrlsRequest

public CreateSignUrlsRequest()

CreateSignUrlsRequest

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

getAgent

public Agent getAgent()

Get 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

Returns:

Agent 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

setAgent

public void setAgent(Agent Agent)

Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

Parameters:

Agent - 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。

getFlowIds

public String[] getFlowIds()

Get 签署流程编号数组，最多支持100个。

Returns:

FlowIds 签署流程编号数组，最多支持100个。

setFlowIds

public void setFlowIds(String[] FlowIds)

Set 签署流程编号数组，最多支持100个。

Parameters:

FlowIds - 签署流程编号数组，最多支持100个。

getEndpoint

public String getEndpoint()

Get 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；

Returns:

Endpoint 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；

setEndpoint

public void setEndpoint(String Endpoint)

Set 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；

Parameters:

Endpoint - 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；

getGenerateType

public String getGenerateType()

Get 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；

Returns:

GenerateType 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；

setGenerateType

public void setGenerateType(String GenerateType)

Set 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；

Parameters:

GenerateType - 签署链接生成类型，默认是 "ALL"； "ALL"：全部签署方签署链接； "CHANNEL"：渠道合作企业； "NOT_CHANNEL"：非渠道合作企业； "PERSON"：个人； "FOLLOWER"：关注方，目前是合同抄送方；

getOrganizationName

public String getOrganizationName()

Get 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填

Returns:

OrganizationName 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填

setOrganizationName

public void setOrganizationName(String OrganizationName)

Set 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填

Parameters:

OrganizationName - 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填

getName

public String getName()

Get 参与人姓名，GenerateType为"PERSON"时必填

Returns:

Name 参与人姓名，GenerateType为"PERSON"时必填

setName

public void setName(String Name)

Set 参与人姓名，GenerateType为"PERSON"时必填

Parameters:

Name - 参与人姓名，GenerateType为"PERSON"时必填

getMobile

public String getMobile()

Get 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填

Returns:

Mobile 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填

setMobile

public void setMobile(String Mobile)

Set 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填

Parameters:

Mobile - 参与人手机号； GenerateType为"PERSON"或"FOLLOWER"时必填

getOrganizationOpenId

public String getOrganizationOpenId()

Get 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填

Returns:

OrganizationOpenId 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填

setOrganizationOpenId

public void setOrganizationOpenId(String OrganizationOpenId)

Set 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填

Parameters:

OrganizationOpenId - 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填

getOpenId

public String getOpenId()

Get 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人

Returns:

OpenId 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人

setOpenId

public void setOpenId(String OpenId)

Set 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人

Parameters:

OpenId - 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人

getAutoJumpBack

public Boolean getAutoJumpBack()

Get Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序

Returns:

AutoJumpBack Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序

setAutoJumpBack

public void setAutoJumpBack(Boolean AutoJumpBack)

Set Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序

Parameters:

AutoJumpBack - Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序

getJumpUrl

public String getJumpUrl()

Get 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。

Returns:

JumpUrl 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。

setJumpUrl

public void setJumpUrl(String JumpUrl)

Set 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。

Parameters:

JumpUrl - 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。

getOperator

public UserInfo getOperator()

Get 操作者的信息

Returns:

Operator 操作者的信息

setOperator

public void setOperator(UserInfo Operator)

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