com.tencentcloudapi.ess.v20201111.models

Class CreateUserVerifyUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateUserVerifyUrlRequest

public class CreateUserVerifyUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateUserVerifyUrlRequest()
CreateUserVerifyUrlRequest(CreateUserVerifyUrlRequest 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
Boolean	getAutoJumpBack() Get 签署完成后是否自动回跳 false：否, 实名完成不会自动跳转回来(默认)true：是, 实名完成会自动跳转回来 注: 1.
String	getEndpoint() Get 要跳转的链接类型 - HTTP： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) - HTTP_SHORT_URL： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型 如果不传递，默认值是 APP
String	getIdCardNumber() Get 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X
String	getIdCardType() Get 证件类型，目前只支持身份证类型：ID_CARD
String	getMobile() Get 要实名的手机号，兼容带+86的格式
String	getName() Get 要实名的姓名
UserInfo	getOperator() Get 操作人信息
String	getUserData() Get 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
void	setAutoJumpBack(Boolean AutoJumpBack) Set 签署完成后是否自动回跳 false：否, 实名完成不会自动跳转回来(默认)true：是, 实名完成会自动跳转回来 注: 1.
void	setEndpoint(String Endpoint) Set 要跳转的链接类型 - HTTP： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) - HTTP_SHORT_URL： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型 如果不传递，默认值是 APP
void	setIdCardNumber(String IdCardNumber) Set 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X
void	setIdCardType(String IdCardType) Set 证件类型，目前只支持身份证类型：ID_CARD
void	setMobile(String Mobile) Set 要实名的手机号，兼容带+86的格式
void	setName(String Name) Set 要实名的姓名
void	setOperator(UserInfo Operator) Set 操作人信息
void	setUserData(String UserData) Set 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
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

CreateUserVerifyUrlRequest

public CreateUserVerifyUrlRequest()

CreateUserVerifyUrlRequest

public CreateUserVerifyUrlRequest(CreateUserVerifyUrlRequest 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 操作人信息

Returns:

Operator 操作人信息

setOperator

public void setOperator(UserInfo Operator)

Set 操作人信息

Parameters:

Operator - 操作人信息

getName

public String getName()

Get 要实名的姓名

Returns:

Name 要实名的姓名

setName

public void setName(String Name)

Set 要实名的姓名

Parameters:

Name - 要实名的姓名

getIdCardNumber

public String getIdCardNumber()

Get 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X

Returns:

IdCardNumber 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X

setIdCardNumber

public void setIdCardNumber(String IdCardNumber)

Set 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X

Parameters:

IdCardNumber - 要实名的身份证号码， 身份证号码如果有x的话，统一传大写X

getIdCardType

public String getIdCardType()

Get 证件类型，目前只支持身份证类型：ID_CARD

Returns:

IdCardType 证件类型，目前只支持身份证类型：ID_CARD

setIdCardType

public void setIdCardType(String IdCardType)

Set 证件类型，目前只支持身份证类型：ID_CARD

Parameters:

IdCardType - 证件类型，目前只支持身份证类型：ID_CARD

getMobile

public String getMobile()

Get 要实名的手机号，兼容带+86的格式

Returns:

Mobile 要实名的手机号，兼容带+86的格式

setMobile

public void setMobile(String Mobile)

Set 要实名的手机号，兼容带+86的格式

Parameters:

Mobile - 要实名的手机号，兼容带+86的格式

getEndpoint

public String getEndpoint()

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

Returns:

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

setEndpoint

public void setEndpoint(String Endpoint)

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

Parameters:

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

getAutoJumpBack

public Boolean getAutoJumpBack()

Get 签署完成后是否自动回跳

• false：否, 实名完成不会自动跳转回来(默认)
• true：是, 实名完成会自动跳转回来

注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）

Returns:

AutoJumpBack 签署完成后是否自动回跳

• false：否, 实名完成不会自动跳转回来(默认)
• true：是, 实名完成会自动跳转回来

注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）

setAutoJumpBack

public void setAutoJumpBack(Boolean AutoJumpBack)

Set 签署完成后是否自动回跳

• false：否, 实名完成不会自动跳转回来(默认)
• true：是, 实名完成会自动跳转回来

注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）

Parameters:

AutoJumpBack - 签署完成后是否自动回跳

• false：否, 实名完成不会自动跳转回来(默认)
• true：是, 实名完成会自动跳转回来

注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）

getUserData

public String getUserData()

Get 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。

Returns:

UserData 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。

setUserData

public void setUserData(String UserData)

Set 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。

Parameters:

UserData - 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel