CreateSchemeUrlRequest (tencentcloud-sdk-java 3.1.1283 API)

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

public class CreateSchemeUrlRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CreateSchemeUrlRequest()`
`CreateSchemeUrlRequest(CreateSchemeUrlRequest 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
`Agent`	`getAgent()` Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`Boolean`	`getAutoJumpBack()` Get 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`String`	`getEndPoint()` Get 要跳转的链接类型 HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
`String`	`getFlowGroupId()` Get 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
`FlowGroupUrlInfo`	`getFlowGroupUrlInfo()` Get 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
`String`	`getFlowId()` Get 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
`Long[]`	`getHides()` Get 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`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 : 中国港澳台居民居住证(格式同中国大陆居民身份证) `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
`String`	`getMobile()` Get 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
`String`	`getName()` Get 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
`UserInfo`	`getOperator()` Get 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`String`	`getOrganizationName()` Get 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
`Long`	`getPathType()` Get 要跳转到的页面类型 0 : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面 1 : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面 2 : 腾讯电子签小程序合同列表页点击查看示例页面 3 : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
`Boolean`	`getPickUpAfterJoined()` Get 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
`String`	`getRecipientId()` Get 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
`String`	`getUrlUseEnv()` Get 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 WeChatOfficialAccounts，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
`void`	`setAgent(Agent Agent)` Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setAutoJumpBack(Boolean AutoJumpBack)` Set 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`void`	`setEndPoint(String EndPoint)` Set 要跳转的链接类型 HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
`void`	`setFlowGroupId(String FlowGroupId)` Set 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
`void`	`setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)` Set 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
`void`	`setFlowId(String FlowId)` Set 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
`void`	`setHides(Long[] Hides)` Set 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`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`	`setMobile(String Mobile)` Set 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
`void`	`setName(String Name)` Set 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
`void`	`setOperator(UserInfo Operator)` Set 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`void`	`setOrganizationName(String OrganizationName)` Set 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
`void`	`setPathType(Long PathType)` Set 要跳转到的页面类型 0 : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面 1 : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面 2 : 腾讯电子签小程序合同列表页点击查看示例页面 3 : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
`void`	`setPickUpAfterJoined(Boolean PickUpAfterJoined)` Set 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
`void`	`setRecipientId(String RecipientId)` Set 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
`void`	`setUrlUseEnv(String UrlUseEnv)` Set 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 WeChatOfficialAccounts，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
`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
  - CreateSchemeUrlRequest
```
public CreateSchemeUrlRequest()
```
  - CreateSchemeUrlRequest
```
public CreateSchemeUrlRequest(CreateSchemeUrlRequest 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 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Returns:
    
    Operator 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - setOperator
```
public void setOperator(UserInfo Operator)
```
    Set 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Parameters:
    
    Operator - 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - getOrganizationName
```
public String getOrganizationName()
```
    Get 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
    
    Returns:
    
    OrganizationName 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
  - setOrganizationName
```
public void setOrganizationName(String OrganizationName)
```
    Set 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
    
    Parameters:
    
    OrganizationName - 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
  - getName
```
public String getName()
```
    Get 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    
    Returns:
    
    Name 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - setName
```
public void setName(String Name)
```
    Set 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    
    Parameters:
    
    Name - 合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - getMobile
```
public String getMobile()
```
    Get 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    
    Returns:
    
    Mobile 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - setMobile
```
public void setMobile(String Mobile)
```
    Set 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    
    Parameters:
    
    Mobile - 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。 `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - 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 : 中国港澳台居民居住证(格式同中国大陆居民身份证)
    `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
  - 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位字符串。
    `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - getEndPoint
```
public String getEndPoint()
```
    Get 要跳转的链接类型
    - **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型)
    - **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    - **APP**：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    Returns:
    EndPoint 要跳转的链接类型
    **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型)
    
    **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    
    **APP**：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
  - setEndPoint
```
public void setEndPoint(String EndPoint)
```
    Set 要跳转的链接类型
    - **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型)
    - **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    - **APP**：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    Parameters:
    EndPoint - 要跳转的链接类型
    **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型)
    
    **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    
    **APP**：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
  - getFlowId
```
public String getFlowId()
```
    Get 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
    
    Returns:
    
    FlowId 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
  - setFlowId
```
public void setFlowId(String FlowId)
```
    Set 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
    
    Parameters:
    
    FlowId - 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
  - getFlowGroupId
```
public String getFlowGroupId()
```
    Get 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
    
    Returns:
    
    FlowGroupId 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
  - setFlowGroupId
```
public void setFlowGroupId(String FlowGroupId)
```
    Set 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
    
    Parameters:
    
    FlowGroupId - 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
  - getPathType
```
public Long getPathType()
```
    Get 要跳转到的页面类型
    - **0** : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面
    - **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面
    - **2** : 腾讯电子签小程序合同列表页点击查看示例页面
    - **3** : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
    Returns:
    PathType 要跳转到的页面类型
    **0** : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面
    **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面
    **2** : 腾讯电子签小程序合同列表页点击查看示例页面
    **3** : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
  - setPathType
```
public void setPathType(Long PathType)
```
    Set 要跳转到的页面类型
    - **0** : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面
    - **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面
    - **2** : 腾讯电子签小程序合同列表页点击查看示例页面
    - **3** : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
    Parameters:
    PathType - 要跳转到的页面类型
    **0** : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面
    **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面
    **2** : 腾讯电子签小程序合同列表页点击查看示例页面
    **3** : 腾讯电子签小程序合同封面页（注：`生成动态签署人补充链接时，必须指定为封面页`）点击查看示例页面
  - getAutoJumpBack
```
public Boolean getAutoJumpBack()
```
    Get 签署完成后是否自动回跳
    - **false**：否, 签署完成不会自动跳转回来(默认)
    - **true**：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对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类型（电子签小程序跳转贵方小程序）场景的签署链接有效 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类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
    Parameters:
    AutoJumpBack - 签署完成后是否自动回跳
    **false**：否, 签署完成不会自动跳转回来(默认)
    **true**：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
  - getAgent
```
public Agent getAgent()
```
    Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Returns:
    
    Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Parameters:
    
    Agent - 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - getHides
```
public Long[] getHides()
```
    Get 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    - **0** :合同签署页面更多操作按钮
    - **1** :合同签署页面更多操作的拒绝签署按钮
    - **2** :合同签署页面更多操作的转他人处理按钮
    - **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
    Returns:
    Hides 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    **0** :合同签署页面更多操作按钮
    
    **1** :合同签署页面更多操作的拒绝签署按钮
    
    **2** :合同签署页面更多操作的转他人处理按钮
    
    **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
  - setHides
```
public void setHides(Long[] Hides)
```
    Set 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    - **0** :合同签署页面更多操作按钮
    - **1** :合同签署页面更多操作的拒绝签署按钮
    - **2** :合同签署页面更多操作的转他人处理按钮
    - **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
    Parameters:
    Hides - 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    **0** :合同签署页面更多操作按钮
    
    **1** :合同签署页面更多操作的拒绝签署按钮
    
    **2** :合同签署页面更多操作的转他人处理按钮
    
    **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
  - getRecipientId
```
public String getRecipientId()
```
    Get 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
    
    Returns:
    
    RecipientId 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
  - setRecipientId
```
public void setRecipientId(String RecipientId)
```
    Set 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
    
    Parameters:
    
    RecipientId - 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
  - getFlowGroupUrlInfo
```
public FlowGroupUrlInfo getFlowGroupUrlInfo()
```
    Get 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
    
    Returns:
    
    FlowGroupUrlInfo 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
  - setFlowGroupUrlInfo
```
public void setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)
```
    Set 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
    
    Parameters:
    
    FlowGroupUrlInfo - 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
  - getUrlUseEnv
```
public String getUrlUseEnv()
```
    Get 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
    
    Returns:
    
    UrlUseEnv 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
  - setUrlUseEnv
```
public void setUrlUseEnv(String UrlUseEnv)
```
    Set 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
    
    Parameters:
    
    UrlUseEnv - 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
  - getPickUpAfterJoined
```
public Boolean getPickUpAfterJoined()
```
    Get 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
    
    Returns:
    
    PickUpAfterJoined 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
  - setPickUpAfterJoined
```
public void setPickUpAfterJoined(Boolean PickUpAfterJoined)
```
    Set 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
    
    Parameters:
    
    PickUpAfterJoined - 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class CreateSchemeUrlRequest

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

CreateSchemeUrlRequest

CreateSchemeUrlRequest

Method Detail

getOperator

setOperator

getOrganizationName

setOrganizationName

getName

setName

getMobile

setMobile

getIdCardType

setIdCardType

getIdCardNumber

setIdCardNumber

getEndPoint

setEndPoint

getFlowId

setFlowId

getFlowGroupId

setFlowGroupId

getPathType

setPathType

getAutoJumpBack

setAutoJumpBack

getAgent

setAgent

getHides

setHides

getRecipientId

setRecipientId

getFlowGroupUrlInfo

setFlowGroupUrlInfo

getUrlUseEnv

setUrlUseEnv

getPickUpAfterJoined

setPickUpAfterJoined

toMap