AutoSignConfig (tencentcloud-sdk-java 3.1.1164 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ess.v20201111.models.AutoSignConfig

public class AutoSignConfig
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`AutoSignConfig()`
`AutoSignConfig(AutoSignConfig 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 Deprecated Methods
Modifier and Type	Method and Description
`String`	`getCallbackUrl()` Deprecated.
`Boolean`	`getCertInfoCallback()` Get 是否回调证书信息: false: 不需要(默认) true:需要
`String`	`getJumpUrl()` Get 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：贵方H5 -> 腾讯电子签H5 -> 贵方H5 : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。贵方原生App -> 腾讯电子签H5 -> 贵方原生App : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS 成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
`Long`	`getLicenseType()` Get 设置用户自动签合同的扣费方式。 1: (默认)使用合同份额进行扣减
`Boolean`	`getSealImgCallback()` Get 回调中是否需要自动签将要使用的印章(签名) 图片的 base64: false: 不需要(默认) true: 需要
`Boolean`	`getUserDefineSeal()` Get 是否支持用户自定义签名印章: false: 不能自己定义(默认) true: 可以自己定义
`UserThreeFactor`	`getUserInfo()` Get 自动签开通个人用户信息, 包括名字,身份证等
`String[]`	`getVerifyChannels()` Get 开通时候的身份验证方式, 取值为： WEIXINAPP : 微信人脸识别 INSIGHT : 慧眼人脸认别 TELECOM : 运营商三要素验证注：如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
`void`	`setCallbackUrl(String CallbackUrl)` Deprecated.
`void`	`setCertInfoCallback(Boolean CertInfoCallback)` Set 是否回调证书信息: false: 不需要(默认) true:需要
`void`	`setJumpUrl(String JumpUrl)` Set 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：贵方H5 -> 腾讯电子签H5 -> 贵方H5 : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。贵方原生App -> 腾讯电子签H5 -> 贵方原生App : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS 成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
`void`	`setLicenseType(Long LicenseType)` Set 设置用户自动签合同的扣费方式。 1: (默认)使用合同份额进行扣减
`void`	`setSealImgCallback(Boolean SealImgCallback)` Set 回调中是否需要自动签将要使用的印章(签名) 图片的 base64: false: 不需要(默认) true: 需要
`void`	`setUserDefineSeal(Boolean UserDefineSeal)` Set 是否支持用户自定义签名印章: false: 不能自己定义(默认) true: 可以自己定义
`void`	`setUserInfo(UserThreeFactor UserInfo)` Set 自动签开通个人用户信息, 包括名字,身份证等
`void`	`setVerifyChannels(String[] VerifyChannels)` Set 开通时候的身份验证方式, 取值为： WEIXINAPP : 微信人脸识别 INSIGHT : 慧眼人脸认别 TELECOM : 运营商三要素验证注：如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
`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
  - AutoSignConfig
```
public AutoSignConfig()
```
  - AutoSignConfig
```
public AutoSignConfig(AutoSignConfig 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
  - getUserInfo
```
public UserThreeFactor getUserInfo()
```
    Get 自动签开通个人用户信息, 包括名字,身份证等
    
    Returns:
    
    UserInfo 自动签开通个人用户信息, 包括名字,身份证等
  - setUserInfo
```
public void setUserInfo(UserThreeFactor UserInfo)
```
    Set 自动签开通个人用户信息, 包括名字,身份证等
    
    Parameters:
    
    UserInfo - 自动签开通个人用户信息, 包括名字,身份证等
  - getCertInfoCallback
```
public Boolean getCertInfoCallback()
```
    Get 是否回调证书信息:
    - **false**: 不需要(默认)
    - **true**:需要
    Returns:
    CertInfoCallback 是否回调证书信息:
    **false**: 不需要(默认)
    
    **true**:需要
  - setCertInfoCallback
```
public void setCertInfoCallback(Boolean CertInfoCallback)
```
    Set 是否回调证书信息:
    - **false**: 不需要(默认)
    - **true**:需要
    Parameters:
    CertInfoCallback - 是否回调证书信息:
    **false**: 不需要(默认)
    
    **true**:需要
  - getUserDefineSeal
```
public Boolean getUserDefineSeal()
```
    Get 是否支持用户自定义签名印章:
    - **false**: 不能自己定义(默认)
    - **true**: 可以自己定义
    Returns:
    UserDefineSeal 是否支持用户自定义签名印章:
    **false**: 不能自己定义(默认)
    
    **true**: 可以自己定义
  - setUserDefineSeal
```
public void setUserDefineSeal(Boolean UserDefineSeal)
```
    Set 是否支持用户自定义签名印章:
    - **false**: 不能自己定义(默认)
    - **true**: 可以自己定义
    Parameters:
    UserDefineSeal - 是否支持用户自定义签名印章:
    **false**: 不能自己定义(默认)
    
    **true**: 可以自己定义
  - getSealImgCallback
```
public Boolean getSealImgCallback()
```
    Get 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
    - **false**: 不需要(默认)
    - **true**: 需要
    Returns:
    SealImgCallback 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
    **false**: 不需要(默认)
    
    **true**: 需要
  - setSealImgCallback
```
public void setSealImgCallback(Boolean SealImgCallback)
```
    Set 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
    - **false**: 不需要(默认)
    - **true**: 需要
    Parameters:
    SealImgCallback - 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
    **false**: 不需要(默认)
    
    **true**: 需要
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块。
    
    Returns:
    
    CallbackUrl 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块。
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String CallbackUrl)
```
    Deprecated.
    
    Set 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块。
    
    Parameters:
    
    CallbackUrl - 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块。
  - getVerifyChannels
```
public String[] getVerifyChannels()
```
    Get 开通时候的身份验证方式, 取值为：
    - **WEIXINAPP** : 微信人脸识别
    - **INSIGHT** : 慧眼人脸认别
    - **TELECOM** : 运营商三要素验证
    注：
    - 如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
    - 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
    Returns:
    VerifyChannels 开通时候的身份验证方式, 取值为：
    **WEIXINAPP** : 微信人脸识别
    
    **INSIGHT** : 慧眼人脸认别
    
    **TELECOM** : 运营商三要素验证
    注：
    如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
    
    如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
  - setVerifyChannels
```
public void setVerifyChannels(String[] VerifyChannels)
```
    Set 开通时候的身份验证方式, 取值为：
    - **WEIXINAPP** : 微信人脸识别
    - **INSIGHT** : 慧眼人脸认别
    - **TELECOM** : 运营商三要素验证
    注：
    - 如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
    - 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
    Parameters:
    VerifyChannels - 开通时候的身份验证方式, 取值为：
    **WEIXINAPP** : 微信人脸识别
    
    **INSIGHT** : 慧眼人脸认别
    
    **TELECOM** : 运营商三要素验证
    注：
    如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
    
    如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
  - getLicenseType
```
public Long getLicenseType()
```
    Get 设置用户自动签合同的扣费方式。
    - 1: (默认)使用合同份额进行扣减
    Returns:
    LicenseType 设置用户自动签合同的扣费方式。
    1: (默认)使用合同份额进行扣减
  - setLicenseType
```
public void setLicenseType(Long LicenseType)
```
    Set 设置用户自动签合同的扣费方式。
    - 1: (默认)使用合同份额进行扣减
    Parameters:
    LicenseType - 设置用户自动签合同的扣费方式。
    1: (默认)使用合同份额进行扣减
  - getJumpUrl
```
public String getJumpUrl()
```
    Get 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：
    - **贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。
    - **贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS
    成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
    Returns:
    JumpUrl 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：
    **贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。
    
    **贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS
    成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
  - setJumpUrl
```
public void setJumpUrl(String JumpUrl)
```
    Set 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：
    - **贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。
    - **贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS
    成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
    Parameters:
    JumpUrl - 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景：
    **贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。
    
    **贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS
    成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
  - 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 AutoSignConfig

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

AutoSignConfig

AutoSignConfig

Method Detail

getUserInfo

setUserInfo

getCertInfoCallback

setCertInfoCallback

getUserDefineSeal

setUserDefineSeal

getSealImgCallback

setSealImgCallback

getCallbackUrl

setCallbackUrl

getVerifyChannels

setVerifyChannels

getLicenseType

setLicenseType

getJumpUrl

setJumpUrl

toMap