CreateUserVerifyUrlRequest (tencentcloud-sdk-java 3.1.1121 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAutoJumpBack()` Get 签署完成后是否自动回跳 false：否, 实名完成不会自动跳转回来(默认)true：是, 实名完成会自动跳转回来注: 1.
`String`	`getEndpoint()` Get 要跳转的链接类型 HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径 H5：适用于跳转至电子签H5实名页面的长链接 H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接注：如果不传递，默认值是 APP
`String`	`getIdCardNumber()` Get 要实名的身份证号码，身份证号码如果有x的话，统一传大写X
`String`	`getIdCardType()` Get 证件类型，目前只支持身份证类型：ID_CARD
`String`	`getJumpUrl()` Get 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
`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：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径 H5：适用于跳转至电子签H5实名页面的长链接 H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接注：如果不传递，默认值是 APP
`void`	`setIdCardNumber(String IdCardNumber)` Set 要实名的身份证号码，身份证号码如果有x的话，统一传大写X
`void`	`setIdCardType(String IdCardType)` Set 证件类型，目前只支持身份证类型：ID_CARD
`void`	`setJumpUrl(String JumpUrl)` Set 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
`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的格式
  - getJumpUrl
```
public String getJumpUrl()
```
    Get 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
    
    Returns:
    
    JumpUrl 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
  - setJumpUrl
```
public void setJumpUrl(String JumpUrl)
```
    Set 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
    
    Parameters:
    
    JumpUrl - 实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
  - getEndpoint
```
public String getEndpoint()
```
    Get 要跳转的链接类型
    - HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
    - HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
    - APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
    - H5：适用于跳转至电子签H5实名页面的长链接
    - H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
    注：如果不传递，默认值是 APP
    Returns:
    Endpoint 要跳转的链接类型
    
    HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
    
    HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
    
    APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
    
    H5：适用于跳转至电子签H5实名页面的长链接
    
    H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
    
    注：如果不传递，默认值是 APP
  - setEndpoint
```
public void setEndpoint(String Endpoint)
```
    Set 要跳转的链接类型
    - HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
    - HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
    - APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
    - H5：适用于跳转至电子签H5实名页面的长链接
    - H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
    注：如果不传递，默认值是 APP
    Parameters:
    Endpoint - 要跳转的链接类型
    
    HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
    
    HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
    
    APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
    
    H5：适用于跳转至电子签H5实名页面的长链接
    
    H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
    
    注：如果不传递，默认值是 APP
  - getAutoJumpBack
```
public Boolean getAutoJumpBack()
```
    Get 签署完成后是否自动回跳
    - false：否, 实名完成不会自动跳转回来(默认)
    - true：是, 实名完成会自动跳转回来
    注: 1. 该参数只针对APP类型（第三方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类型（第三方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类型（第三方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类型（第三方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

Class CreateUserVerifyUrlRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateUserVerifyUrlRequest

CreateUserVerifyUrlRequest

Method Detail

getOperator

setOperator

getName

setName

getIdCardNumber

setIdCardNumber

getIdCardType

setIdCardType

getMobile

setMobile

getJumpUrl

setJumpUrl

getEndpoint

setEndpoint

getAutoJumpBack

setAutoJumpBack

getUserData

setUserData

toMap