Recipient (tencentcloud-sdk-java 3.1.1010 API)

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

public class Recipient
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`Recipient()`
`Recipient(Recipient 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
`Long[]`	`getApproverSignTypes()` Get 签署人进行合同签署时的认证方式，支持的类型如下: 1 :人脸认证 2 :签署密码 3 :运营商三要素认证 4 :UKey认证
`Long[]`	`getApproverVerifyTypes()` Get 签署人查看合同校验方式, 支持的类型如下: 1 :实名认证查看 2 :手机号校验查看
`String`	`getDeliveryMethod()` Get 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
`String`	`getDescription()` Get 描述信息
`String`	`getEmail()` Get 邮箱地址
`String`	`getMobile()` Get 电话号码
`String`	`getRecipientExtra()` Get 参与方的一些附属信息，json格式
`String`	`getRecipientId()` Get 签署参与者ID，唯一标识
`String`	`getRecipientType()` Get 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
`Boolean`	`getRequireDelivery()` Get 是否需要发送，默认为true-需要发送
`Boolean`	`getRequireSign()` Get 是否需要签署，默认为true-需要签署
`Boolean`	`getRequireValidation()` Get 是否需要验证，默认为false-不需要验证
`String`	`getRoleName()` Get 角色名称
`Long`	`getRoutingOrder()` Get 此参与方添加的顺序，从0～N
`String`	`getUserId()` Get 关联的用户ID，电子签系统的用户ID
`void`	`setApproverSignTypes(Long[] ApproverSignTypes)` Set 签署人进行合同签署时的认证方式，支持的类型如下: 1 :人脸认证 2 :签署密码 3 :运营商三要素认证 4 :UKey认证
`void`	`setApproverVerifyTypes(Long[] ApproverVerifyTypes)` Set 签署人查看合同校验方式, 支持的类型如下: 1 :实名认证查看 2 :手机号校验查看
`void`	`setDeliveryMethod(String DeliveryMethod)` Set 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
`void`	`setDescription(String Description)` Set 描述信息
`void`	`setEmail(String Email)` Set 邮箱地址
`void`	`setMobile(String Mobile)` Set 电话号码
`void`	`setRecipientExtra(String RecipientExtra)` Set 参与方的一些附属信息，json格式
`void`	`setRecipientId(String RecipientId)` Set 签署参与者ID，唯一标识
`void`	`setRecipientType(String RecipientType)` Set 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
`void`	`setRequireDelivery(Boolean RequireDelivery)` Set 是否需要发送，默认为true-需要发送
`void`	`setRequireSign(Boolean RequireSign)` Set 是否需要签署，默认为true-需要签署
`void`	`setRequireValidation(Boolean RequireValidation)` Set 是否需要验证，默认为false-不需要验证
`void`	`setRoleName(String RoleName)` Set 角色名称
`void`	`setRoutingOrder(Long RoutingOrder)` Set 此参与方添加的顺序，从0～N
`void`	`setUserId(String UserId)` Set 关联的用户ID，电子签系统的用户ID
`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
  - Recipient
```
public Recipient()
```
  - Recipient
```
public Recipient(Recipient 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
  - getRecipientId
```
public String getRecipientId()
```
    Get 签署参与者ID，唯一标识
    
    Returns:
    
    RecipientId 签署参与者ID，唯一标识
  - setRecipientId
```
public void setRecipientId(String RecipientId)
```
    Set 签署参与者ID，唯一标识
    
    Parameters:
    
    RecipientId - 签署参与者ID，唯一标识
  - getRecipientType
```
public String getRecipientType()
```
    Get 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
    
    Returns:
    
    RecipientType 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
  - setRecipientType
```
public void setRecipientType(String RecipientType)
```
    Set 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
    
    Parameters:
    
    RecipientType - 参与者类型。默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方
  - getDescription
```
public String getDescription()
```
    Get 描述信息
    
    Returns:
    
    Description 描述信息
  - setDescription
```
public void setDescription(String Description)
```
    Set 描述信息
    
    Parameters:
    
    Description - 描述信息
  - getRoleName
```
public String getRoleName()
```
    Get 角色名称
    
    Returns:
    
    RoleName 角色名称
  - setRoleName
```
public void setRoleName(String RoleName)
```
    Set 角色名称
    
    Parameters:
    
    RoleName - 角色名称
  - getRequireValidation
```
public Boolean getRequireValidation()
```
    Get 是否需要验证，默认为false-不需要验证
    
    Returns:
    
    RequireValidation 是否需要验证，默认为false-不需要验证
  - setRequireValidation
```
public void setRequireValidation(Boolean RequireValidation)
```
    Set 是否需要验证，默认为false-不需要验证
    
    Parameters:
    
    RequireValidation - 是否需要验证，默认为false-不需要验证
  - getRequireSign
```
public Boolean getRequireSign()
```
    Get 是否需要签署，默认为true-需要签署
    
    Returns:
    
    RequireSign 是否需要签署，默认为true-需要签署
  - setRequireSign
```
public void setRequireSign(Boolean RequireSign)
```
    Set 是否需要签署，默认为true-需要签署
    
    Parameters:
    
    RequireSign - 是否需要签署，默认为true-需要签署
  - getRoutingOrder
```
public Long getRoutingOrder()
```
    Get 此参与方添加的顺序，从0～N
    
    Returns:
    
    RoutingOrder 此参与方添加的顺序，从0～N
  - setRoutingOrder
```
public void setRoutingOrder(Long RoutingOrder)
```
    Set 此参与方添加的顺序，从0～N
    
    Parameters:
    
    RoutingOrder - 此参与方添加的顺序，从0～N
  - getRequireDelivery
```
public Boolean getRequireDelivery()
```
    Get 是否需要发送，默认为true-需要发送
    
    Returns:
    
    RequireDelivery 是否需要发送，默认为true-需要发送
  - setRequireDelivery
```
public void setRequireDelivery(Boolean RequireDelivery)
```
    Set 是否需要发送，默认为true-需要发送
    
    Parameters:
    
    RequireDelivery - 是否需要发送，默认为true-需要发送
  - getEmail
```
public String getEmail()
```
    Get 邮箱地址
    
    Returns:
    
    Email 邮箱地址
  - setEmail
```
public void setEmail(String Email)
```
    Set 邮箱地址
    
    Parameters:
    
    Email - 邮箱地址
  - getMobile
```
public String getMobile()
```
    Get 电话号码
    
    Returns:
    
    Mobile 电话号码
  - setMobile
```
public void setMobile(String Mobile)
```
    Set 电话号码
    
    Parameters:
    
    Mobile - 电话号码
  - getUserId
```
public String getUserId()
```
    Get 关联的用户ID，电子签系统的用户ID
    
    Returns:
    
    UserId 关联的用户ID，电子签系统的用户ID
  - setUserId
```
public void setUserId(String UserId)
```
    Set 关联的用户ID，电子签系统的用户ID
    
    Parameters:
    
    UserId - 关联的用户ID，电子签系统的用户ID
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Get 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
    
    Returns:
    
    DeliveryMethod 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
  - setDeliveryMethod
```
public void setDeliveryMethod(String DeliveryMethod)
```
    Set 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
    
    Parameters:
    
    DeliveryMethod - 发送方式，默认为EMAIL。 EMAIL-邮件； MOBILE-手机短信； WECHAT-微信通知
  - getRecipientExtra
```
public String getRecipientExtra()
```
    Get 参与方的一些附属信息，json格式
    
    Returns:
    
    RecipientExtra 参与方的一些附属信息，json格式
  - setRecipientExtra
```
public void setRecipientExtra(String RecipientExtra)
```
    Set 参与方的一些附属信息，json格式
    
    Parameters:
    
    RecipientExtra - 参与方的一些附属信息，json格式
  - getApproverVerifyTypes
```
public Long[] getApproverVerifyTypes()
```
    Get 签署人查看合同校验方式, 支持的类型如下:
    - 1 :实名认证查看
    - 2 :手机号校验查看
    Returns:
    ApproverVerifyTypes 签署人查看合同校验方式, 支持的类型如下:
    1 :实名认证查看
    
    2 :手机号校验查看
  - setApproverVerifyTypes
```
public void setApproverVerifyTypes(Long[] ApproverVerifyTypes)
```
    Set 签署人查看合同校验方式, 支持的类型如下:
    - 1 :实名认证查看
    - 2 :手机号校验查看
    Parameters:
    ApproverVerifyTypes - 签署人查看合同校验方式, 支持的类型如下:
    1 :实名认证查看
    
    2 :手机号校验查看
  - getApproverSignTypes
```
public Long[] getApproverSignTypes()
```
    Get 签署人进行合同签署时的认证方式，支持的类型如下:
    - 1 :人脸认证
    - 2 :签署密码
    - 3 :运营商三要素认证
    - 4 :UKey认证
    Returns:
    ApproverSignTypes 签署人进行合同签署时的认证方式，支持的类型如下:
    1 :人脸认证
    
    2 :签署密码
    
    3 :运营商三要素认证
    
    4 :UKey认证
  - setApproverSignTypes
```
public void setApproverSignTypes(Long[] ApproverSignTypes)
```
    Set 签署人进行合同签署时的认证方式，支持的类型如下:
    - 1 :人脸认证
    - 2 :签署密码
    - 3 :运营商三要素认证
    - 4 :UKey认证
    Parameters:
    ApproverSignTypes - 签署人进行合同签署时的认证方式，支持的类型如下:
    1 :人脸认证
    
    2 :签署密码
    
    3 :运营商三要素认证
    
    4 :UKey认证
  - 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 Recipient

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

Recipient

Recipient

Method Detail

getRecipientId

setRecipientId

getRecipientType

setRecipientType

getDescription

setDescription

getRoleName

setRoleName

getRequireValidation

setRequireValidation

getRequireSign

setRequireSign

getRoutingOrder

setRoutingOrder

getRequireDelivery

setRequireDelivery

getEmail

setEmail

getMobile

setMobile

getUserId

setUserId

getDeliveryMethod

setDeliveryMethod

getRecipientExtra

setRecipientExtra

getApproverVerifyTypes

setApproverVerifyTypes

getApproverSignTypes

setApproverSignTypes

toMap