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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序
String	getFlowGroupId() Get 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)
String[]	getFlowIds() Get 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)
String	getGenerateType() Get 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接
Long[]	getHides() Get 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮
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() Deprecated.
String	getOrganizationName() Get 非第三方平台子客企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
String	getOrganizationOpenId() Get 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填
String[]	getRecipientIds() Get 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应
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或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序
void	setFlowGroupId(String FlowGroupId) Set 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)
void	setFlowIds(String[] FlowIds) Set 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)
void	setGenerateType(String GenerateType) Set 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接
void	setHides(Long[] Hides) Set 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮
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) Deprecated.
void	setOrganizationName(String OrganizationName) Set 非第三方平台子客企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
void	setOrganizationOpenId(String OrganizationOpenId) Set 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填
void	setRecipientIds(String[] RecipientIds) Set 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应
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, 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

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 必填。

Returns:

Agent 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

setAgent

public void setAgent(Agent Agent)

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

Parameters:

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

getFlowIds

public String[] getFlowIds()

Get 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)

Returns:

FlowIds 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)

setFlowIds

public void setFlowIds(String[] FlowIds)

Set 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)

Parameters:

FlowIds - 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)

getFlowGroupId

public String getFlowGroupId()

Get 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)

Returns:

FlowGroupId 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)

setFlowGroupId

public void setFlowGroupId(String FlowGroupId)

Set 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)

Parameters:

FlowGroupId - 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)

getEndpoint

public String getEndpoint()

Get 签署链接类型,可以设置的参数如下 - WEIXINAPP:短链直接跳小程序 (默认类型) - CHANNEL:跳转H5页面 - APP:第三方APP或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序

Returns:

Endpoint 签署链接类型,可以设置的参数如下 - WEIXINAPP:短链直接跳小程序 (默认类型) - CHANNEL:跳转H5页面 - APP:第三方APP或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序

setEndpoint

public void setEndpoint(String Endpoint)

Set 签署链接类型,可以设置的参数如下 - WEIXINAPP:短链直接跳小程序 (默认类型) - CHANNEL:跳转H5页面 - APP:第三方APP或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序

Parameters:

Endpoint - 签署链接类型,可以设置的参数如下 - WEIXINAPP:短链直接跳小程序 (默认类型) - CHANNEL:跳转H5页面 - APP:第三方APP或小程序跳转电子签小程序 - LONGURL2WEIXINAPP:长链接跳转小程序

getGenerateType

public String getGenerateType()

Get 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接

Returns:

GenerateType 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接

setGenerateType

public void setGenerateType(String GenerateType)

Set 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接

Parameters:

GenerateType - 签署链接生成类型，可以选择的类型如下 - ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型) - CHANNEL：第三方平台子客企业企业 - NOT_CHANNEL：非第三方平台子客企业企业 - PERSON：个人 - FOLLOWER：关注方，目前是合同抄送方 - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接

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 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填

Returns:

OrganizationOpenId 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填

setOrganizationOpenId

public void setOrganizationOpenId(String OrganizationOpenId)

Set 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填

Parameters:

OrganizationOpenId - 第三方平台子客企业的企业OpenId，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

@Deprecated
public UserInfo getOperator()

Deprecated.

Get 暂未开放

Returns:

Operator 暂未开放

setOperator

@Deprecated
public void setOperator(UserInfo Operator)

Deprecated.

Set 暂未开放

Parameters:

Operator - 暂未开放

getHides

public Long[] getHides()

Get 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮

Returns:

Hides 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮

setHides

public void setHides(Long[] Hides)

Set 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮

Parameters:

Hides - 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮

getRecipientIds

public String[] getRecipientIds()

Get 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应

Returns:

RecipientIds 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应

setRecipientIds

public void setRecipientIds(String[] RecipientIds)

Set 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应

Parameters:

RecipientIds - 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel