CreatePreparedPersonalEsignRequest (tencentcloud-sdk-java 3.1.1151 API)

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

public class CreatePreparedPersonalEsignRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CreatePreparedPersonalEsignRequest()`
`CreatePreparedPersonalEsignRequest(CreatePreparedPersonalEsignRequest 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
`Agent`	`getAgent()` Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`Boolean`	`getEnableAutoSign()` Get 此字段已废弃，请勿继续使用。
`String`	`getFileId()` Get 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
`String`	`getIdCardNumber()` Get 证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
`String`	`getIdCardType()` Get 证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
`Long`	`getLicenseType()` Get 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
`String`	`getMobile()` Get 手机号码；当需要开通自动签时，该参数必传
`UserInfo`	`getOperator()` Get 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`Boolean`	`getProcessSeal()` Get 是否处理印章，默认不做印章处理。取值如下： false：不做任何处理； true：做透明化处理和颜色增强。
`String`	`getSceneKey()` Get 自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
`String`	`getSealColor()` Get 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
`String`	`getSealImage()` Deprecated.
`Boolean`	`getSealImageCompress()` Get 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
`String`	`getSealName()` Get 印章名称，长度1-50个字。
`String`	`getUserName()` Get 个人用户姓名
`void`	`setAgent(Agent Agent)` Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setEnableAutoSign(Boolean EnableAutoSign)` Set 此字段已废弃，请勿继续使用。
`void`	`setFileId(String FileId)` Set 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
`void`	`setIdCardNumber(String IdCardNumber)` Set 证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
`void`	`setIdCardType(String IdCardType)` Set 证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
`void`	`setLicenseType(Long LicenseType)` Set 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
`void`	`setMobile(String Mobile)` Set 手机号码；当需要开通自动签时，该参数必传
`void`	`setOperator(UserInfo Operator)` Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`void`	`setProcessSeal(Boolean ProcessSeal)` Set 是否处理印章，默认不做印章处理。取值如下： false：不做任何处理； true：做透明化处理和颜色增强。
`void`	`setSceneKey(String SceneKey)` Set 自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
`void`	`setSealColor(String SealColor)` Set 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
`void`	`setSealImage(String SealImage)` Deprecated.
`void`	`setSealImageCompress(Boolean SealImageCompress)` Set 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
`void`	`setSealName(String SealName)` Set 印章名称，长度1-50个字。
`void`	`setUserName(String UserName)` Set 个人用户姓名
`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
  - CreatePreparedPersonalEsignRequest
```
public CreatePreparedPersonalEsignRequest()
```
  - CreatePreparedPersonalEsignRequest
```
public CreatePreparedPersonalEsignRequest(CreatePreparedPersonalEsignRequest 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
  - getUserName
```
public String getUserName()
```
    Get 个人用户姓名
    
    Returns:
    
    UserName 个人用户姓名
  - setUserName
```
public void setUserName(String UserName)
```
    Set 个人用户姓名
    
    Parameters:
    
    UserName - 个人用户姓名
  - getIdCardNumber
```
public String getIdCardNumber()
```
    Get 证件号码，应符合以下规则
    - 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    - 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
    - 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    Returns:
    IdCardNumber 证件号码，应符合以下规则
    居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    
    港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
    
    港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
  - setIdCardNumber
```
public void setIdCardNumber(String IdCardNumber)
```
    Set 证件号码，应符合以下规则
    - 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    - 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
    - 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    Parameters:
    IdCardNumber - 证件号码，应符合以下规则
    居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    
    港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
    
    港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
  - getSealName
```
public String getSealName()
```
    Get 印章名称，长度1-50个字。
    
    Returns:
    
    SealName 印章名称，长度1-50个字。
  - setSealName
```
public void setSealName(String SealName)
```
    Set 印章名称，长度1-50个字。
    
    Parameters:
    
    SealName - 印章名称，长度1-50个字。
  - getOperator
```
public UserInfo getOperator()
```
    Get 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Returns:
    
    Operator 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - setOperator
```
public void setOperator(UserInfo Operator)
```
    Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Parameters:
    
    Operator - 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - getIdCardType
```
public String getIdCardType()
```
    Get 证件类型，支持以下类型
    - ID_CARD : 中国大陆居民身份证 (默认值)
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
    Returns:
    IdCardType 证件类型，支持以下类型
    ID_CARD : 中国大陆居民身份证 (默认值)
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  - setIdCardType
```
public void setIdCardType(String IdCardType)
```
    Set 证件类型，支持以下类型
    - ID_CARD : 中国大陆居民身份证 (默认值)
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
    Parameters:
    IdCardType - 证件类型，支持以下类型
    ID_CARD : 中国大陆居民身份证 (默认值)
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  - getSealImage
```
@Deprecated
public String getSealImage()
```
    Deprecated.
    
    Get 印章图片的base64 注：已废弃请先通过UploadFiles接口上传文件，获取 FileId
    
    Returns:
    
    SealImage 印章图片的base64 注：已废弃请先通过UploadFiles接口上传文件，获取 FileId
  - setSealImage
```
@Deprecated
public void setSealImage(String SealImage)
```
    Deprecated.
    
    Set 印章图片的base64 注：已废弃请先通过UploadFiles接口上传文件，获取 FileId
    
    Parameters:
    
    SealImage - 印章图片的base64 注：已废弃请先通过UploadFiles接口上传文件，获取 FileId
  - getSealImageCompress
```
public Boolean getSealImageCompress()
```
    Get 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
    
    Returns:
    
    SealImageCompress 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
  - setSealImageCompress
```
public void setSealImageCompress(Boolean SealImageCompress)
```
    Set 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
    
    Parameters:
    
    SealImageCompress - 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
  - getMobile
```
public String getMobile()
```
    Get 手机号码；当需要开通自动签时，该参数必传
    
    Returns:
    
    Mobile 手机号码；当需要开通自动签时，该参数必传
  - setMobile
```
public void setMobile(String Mobile)
```
    Set 手机号码；当需要开通自动签时，该参数必传
    
    Parameters:
    
    Mobile - 手机号码；当需要开通自动签时，该参数必传
  - getEnableAutoSign
```
public Boolean getEnableAutoSign()
```
    Get 此字段已废弃，请勿继续使用。
    
    Returns:
    
    EnableAutoSign 此字段已废弃，请勿继续使用。
  - setEnableAutoSign
```
public void setEnableAutoSign(Boolean EnableAutoSign)
```
    Set 此字段已废弃，请勿继续使用。
    
    Parameters:
    
    EnableAutoSign - 此字段已废弃，请勿继续使用。
  - getSealColor
```
public String getSealColor()
```
    Get 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
    
    Returns:
    
    SealColor 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
  - setSealColor
```
public void setSealColor(String SealColor)
```
    Set 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
    
    Parameters:
    
    SealColor - 印章颜色（参数ProcessSeal=true时生效）默认值：BLACK黑色取值: BLACK 黑色, RED 红色, BLUE 蓝色。
  - getProcessSeal
```
public Boolean getProcessSeal()
```
    Get 是否处理印章，默认不做印章处理。取值如下：
    - false：不做任何处理；
    - true：做透明化处理和颜色增强。
    Returns:
    ProcessSeal 是否处理印章，默认不做印章处理。取值如下：
    
    false：不做任何处理；
    
    true：做透明化处理和颜色增强。
  - setProcessSeal
```
public void setProcessSeal(Boolean ProcessSeal)
```
    Set 是否处理印章，默认不做印章处理。取值如下：
    - false：不做任何处理；
    - true：做透明化处理和颜色增强。
    Parameters:
    ProcessSeal - 是否处理印章，默认不做印章处理。取值如下：
    
    false：不做任何处理；
    
    true：做透明化处理和颜色增强。
  - getFileId
```
public String getFileId()
```
    Get 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
    
    Returns:
    
    FileId 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
  - setFileId
```
public void setFileId(String FileId)
```
    Set 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
    
    Parameters:
    
    FileId - 印章图片文件 id 取值：填写的FileId通过UploadFiles接口上传文件获取。
  - getAgent
```
public Agent getAgent()
```
    Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Returns:
    
    Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Parameters:
    
    Agent - 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - getLicenseType
```
public Long getLicenseType()
```
    Get 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
    
    Returns:
    
    LicenseType 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
  - setLicenseType
```
public void setLicenseType(Long LicenseType)
```
    Set 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
    
    Parameters:
    
    LicenseType - 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
  - getSceneKey
```
public String getSceneKey()
```
    Get 自动签使用的场景值, 可以选择的场景值如下:
    - **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
    - **OTHER** : 通用场景
    注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
    Returns:
    SceneKey 自动签使用的场景值, 可以选择的场景值如下:
    **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
    **OTHER** : 通用场景
    注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
  - setSceneKey
```
public void setSceneKey(String SceneKey)
```
    Set 自动签使用的场景值, 可以选择的场景值如下:
    - **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
    - **OTHER** : 通用场景
    注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
    Parameters:
    SceneKey - 自动签使用的场景值, 可以选择的场景值如下:
    **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
    **OTHER** : 通用场景
    注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
  - 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 CreatePreparedPersonalEsignRequest

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

CreatePreparedPersonalEsignRequest

CreatePreparedPersonalEsignRequest

Method Detail

getUserName

setUserName

getIdCardNumber

setIdCardNumber

getSealName

setSealName

getOperator

setOperator

getIdCardType

setIdCardType

getSealImage

setSealImage

getSealImageCompress

setSealImageCompress

getMobile

setMobile

getEnableAutoSign

setEnableAutoSign

getSealColor

setSealColor

getProcessSeal

setProcessSeal

getFileId

setFileId

getAgent

setAgent

getLicenseType

setLicenseType

getSceneKey

setSceneKey

toMap