com.tencentcloudapi.ess.v20201111.models

Class CreateSchemeUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateSchemeUrlRequest

public class CreateSchemeUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
CreateSchemeUrlRequest()
CreateSchemeUrlRequest(CreateSchemeUrlRequest 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 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
Boolean	getAutoJumpBack() Get 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效
String	getEndPoint() Get 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
String	getFlowGroupId() Get 合同组ID
String	getFlowId() Get 签署流程编号 (PathType=1时必传)
Long[]	getHides() Get 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮
String	getMobile() Get 手机号，大陆手机号11位
String	getName() Get 姓名,最大长度50个字符
UserInfo	getOperator() Get 调用方用户信息，userId 必填
String	getOrganizationName() Get 企业名称
Long	getPathType() Get 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页
void	setAgent(Agent Agent) Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
void	setAutoJumpBack(Boolean AutoJumpBack) Set 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效
void	setEndPoint(String EndPoint) Set 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
void	setFlowGroupId(String FlowGroupId) Set 合同组ID
void	setFlowId(String FlowId) Set 签署流程编号 (PathType=1时必传)
void	setHides(Long[] Hides) Set 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下 - 0:合同签署页面更多操作按钮 - 1:合同签署页面更多操作的拒绝签署按钮 - 2:合同签署页面更多操作的转他人处理按钮 - 3:签署成功页的查看详情按钮
void	setMobile(String Mobile) Set 手机号，大陆手机号11位
void	setName(String Name) Set 姓名,最大长度50个字符
void	setOperator(UserInfo Operator) Set 调用方用户信息，userId 必填
void	setOrganizationName(String OrganizationName) Set 企业名称
void	setPathType(Long PathType) Set 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页
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

CreateSchemeUrlRequest

public CreateSchemeUrlRequest()

CreateSchemeUrlRequest

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

getOperator

public UserInfo getOperator()

Get 调用方用户信息，userId 必填

Returns:

Operator 调用方用户信息，userId 必填

setOperator

public void setOperator(UserInfo Operator)

Set 调用方用户信息，userId 必填

Parameters:

Operator - 调用方用户信息，userId 必填

getOrganizationName

public String getOrganizationName()

Get 企业名称

Returns:

OrganizationName 企业名称

setOrganizationName

public void setOrganizationName(String OrganizationName)

Set 企业名称

Parameters:

OrganizationName - 企业名称

getName

public String getName()

Get 姓名,最大长度50个字符

Returns:

Name 姓名,最大长度50个字符

setName

public void setName(String Name)

Set 姓名,最大长度50个字符

Parameters:

Name - 姓名,最大长度50个字符

getMobile

public String getMobile()

Get 手机号，大陆手机号11位

Returns:

Mobile 手机号，大陆手机号11位

setMobile

public void setMobile(String Mobile)

Set 手机号，大陆手机号11位

Parameters:

Mobile - 手机号，大陆手机号11位

getEndPoint

public String getEndPoint()

Get 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

Returns:

EndPoint 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

setEndPoint

public void setEndPoint(String EndPoint)

Set 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

Parameters:

EndPoint - 要跳转的链接类型 - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)，此时返回长链 - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

getFlowId

public String getFlowId()

Get 签署流程编号 (PathType=1时必传)

Returns:

FlowId 签署流程编号 (PathType=1时必传)

setFlowId

public void setFlowId(String FlowId)

Set 签署流程编号 (PathType=1时必传)

Parameters:

FlowId - 签署流程编号 (PathType=1时必传)

getFlowGroupId

public String getFlowGroupId()

Get 合同组ID

Returns:

FlowGroupId 合同组ID

setFlowGroupId

public void setFlowGroupId(String FlowGroupId)

Set 合同组ID

Parameters:

FlowGroupId - 合同组ID

getPathType

public Long getPathType()

Get 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页

Returns:

PathType 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页

setPathType

public void setPathType(Long PathType)

Set 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页

Parameters:

PathType - 要跳转到的页面类型 - 0: 不传, 主页 (默认) - 1: 小程序合同详情 - 2: 小程序合同列表页

getAutoJumpBack

public Boolean getAutoJumpBack()

Get 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效

Returns:

AutoJumpBack 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效

setAutoJumpBack

public void setAutoJumpBack(Boolean AutoJumpBack)

Set 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效

Parameters:

AutoJumpBack - 是否自动回跳 true：是， false：否。 该参数只针对"APP" 类型的签署链接有效

getAgent

public Agent getAgent()

Get 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Returns:

Agent 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

setAgent

public void setAgent(Agent Agent)

Set 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

Parameters:

Agent - 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

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:签署成功页的查看详情按钮

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel