com.tencentcloudapi.ess.v20201111.models.CreateUserVerifyUrlRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.ess.v20201111.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreateUserVerifyUrlRequest extends AbstractModel {
/**
* 操作人信息
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 要实名的姓名
*/
@SerializedName("Name")
@Expose
private String Name;
/**
* 要实名的身份证号码，
身份证号码如果有x的话，统一传大写X
*/
@SerializedName("IdCardNumber")
@Expose
private String IdCardNumber;
/**
* 证件类型，目前只支持身份证类型：ID_CARD
*/
@SerializedName("IdCardType")
@Expose
private String IdCardType;
/**
* 要实名的手机号，兼容带+86的格式
*/
@SerializedName("Mobile")
@Expose
private String Mobile;
/**
* 实名完之后的跳转链接，最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
*/
@SerializedName("JumpUrl")
@Expose
private String JumpUrl;
/**
* 要跳转的链接类型
- HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
- H5：适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
注：如果不传递，默认值是 APP
*/
@SerializedName("Endpoint")
@Expose
private String Endpoint;
/**
* 签署完成后是否自动回跳
- false：否, 实名完成不会自动跳转回来(默认)
- true：是, 实名完成会自动跳转回来
注:
1. 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景 的实名链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
*/
@SerializedName("AutoJumpBack")
@Expose
private Boolean AutoJumpBack;
/**
* 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](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编码格式。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* Get 操作人信息
* @return Operator 操作人信息
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 操作人信息
* @param Operator 操作人信息
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 要实名的姓名
* @return Name 要实名的姓名
*/
public String getName() {
return this.Name;
}
/**
* Set 要实名的姓名
* @param Name 要实名的姓名
*/
public void setName(String Name) {
this.Name = Name;
}
/**
* Get 要实名的身份证号码，
身份证号码如果有x的话，统一传大写X
* @return IdCardNumber 要实名的身份证号码，
身份证号码如果有x的话，统一传大写X
*/
public String getIdCardNumber() {
return this.IdCardNumber;
}
/**
* Set 要实名的身份证号码，
身份证号码如果有x的话，统一传大写X
* @param IdCardNumber 要实名的身份证号码，
身份证号码如果有x的话，统一传大写X
*/
public void setIdCardNumber(String IdCardNumber) {
this.IdCardNumber = IdCardNumber;
}
/**
* Get 证件类型，目前只支持身份证类型：ID_CARD
* @return IdCardType 证件类型，目前只支持身份证类型：ID_CARD
*/
public String getIdCardType() {
return this.IdCardType;
}
/**
* Set 证件类型，目前只支持身份证类型：ID_CARD
* @param IdCardType 证件类型，目前只支持身份证类型：ID_CARD
*/
public void setIdCardType(String IdCardType) {
this.IdCardType = IdCardType;
}
/**
* Get 要实名的手机号，兼容带+86的格式
* @return Mobile 要实名的手机号，兼容带+86的格式
*/
public String getMobile() {
return this.Mobile;
}
/**
* Set 要实名的手机号，兼容带+86的格式
* @param Mobile 要实名的手机号，兼容带+86的格式
*/
public void setMobile(String Mobile) {
this.Mobile = Mobile;
}
/**
* Get 实名完之后的跳转链接，最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
* @return JumpUrl 实名完之后的跳转链接，最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
*/
public String getJumpUrl() {
return this.JumpUrl;
}
/**
* Set 实名完之后的跳转链接，最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
* @param JumpUrl 实名完之后的跳转链接，最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
*/
public void setJumpUrl(String JumpUrl) {
this.JumpUrl = JumpUrl;
}
/**
* Get 要跳转的链接类型
- HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
- H5：适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
注：如果不传递，默认值是 APP
* @return Endpoint 要跳转的链接类型
- HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
- H5：适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
注：如果不传递，默认值是 APP
*/
public String getEndpoint() {
return this.Endpoint;
}
/**
* Set 要跳转的链接类型
- HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
- H5：适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
注：如果不传递，默认值是 APP
* @param Endpoint 要跳转的链接类型
- HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径
- H5：适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接
注：如果不传递，默认值是 APP
*/
public void setEndpoint(String Endpoint) {
this.Endpoint = Endpoint;
}
/**
* Get 签署完成后是否自动回跳
- false：否, 实名完成不会自动跳转回来(默认)
- true：是, 实名完成会自动跳转回来
注:
1. 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景 的实名链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
* @return AutoJumpBack 签署完成后是否自动回跳
- false：否, 实名完成不会自动跳转回来(默认)
- true：是, 实名完成会自动跳转回来
注:
1. 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景 的实名链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
*/
public Boolean getAutoJumpBack() {
return this.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，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
* @param AutoJumpBack 签署完成后是否自动回跳
- false：否, 实名完成不会自动跳转回来(默认)
- true：是, 实名完成会自动跳转回来
注:
1. 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景 的实名链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
*/
public void setAutoJumpBack(Boolean AutoJumpBack) {
this.AutoJumpBack = AutoJumpBack;
}
/**
* 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编码格式。
* @return 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编码格式。
*/
public String getUserData() {
return this.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编码格式。
* @param 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编码格式。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
public CreateUserVerifyUrlRequest() {
}
/**
* 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.
*/
public CreateUserVerifyUrlRequest(CreateUserVerifyUrlRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.Name != null) {
this.Name = new String(source.Name);
}
if (source.IdCardNumber != null) {
this.IdCardNumber = new String(source.IdCardNumber);
}
if (source.IdCardType != null) {
this.IdCardType = new String(source.IdCardType);
}
if (source.Mobile != null) {
this.Mobile = new String(source.Mobile);
}
if (source.JumpUrl != null) {
this.JumpUrl = new String(source.JumpUrl);
}
if (source.Endpoint != null) {
this.Endpoint = new String(source.Endpoint);
}
if (source.AutoJumpBack != null) {
this.AutoJumpBack = new Boolean(source.AutoJumpBack);
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "Name", this.Name);
this.setParamSimple(map, prefix + "IdCardNumber", this.IdCardNumber);
this.setParamSimple(map, prefix + "IdCardType", this.IdCardType);
this.setParamSimple(map, prefix + "Mobile", this.Mobile);
this.setParamSimple(map, prefix + "JumpUrl", this.JumpUrl);
this.setParamSimple(map, prefix + "Endpoint", this.Endpoint);
this.setParamSimple(map, prefix + "AutoJumpBack", this.AutoJumpBack);
this.setParamSimple(map, prefix + "UserData", this.UserData);
}
}