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	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	Description
`Agent`	`getAgent()`	Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`Boolean`	`getAutoJumpBack()`	Get 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: ` 该参数只针对"APP" 类型的签署链接有效`
`String`	`getEndPoint()`	Get 要跳转的链接类型 HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
`String`	`getFlowGroupId()`	Get 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
`String`	`getFlowId()`	Get 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
`Long[]`	`getHides()`	Get 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`String`	`getMobile()`	Get 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。
`String`	`getName()`	Get 合同流程里边签署方经办人的姓名。
`UserInfo`	`getOperator()`	Get 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`String`	`getOrganizationName()`	Get 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
`Long`	`getPathType()`	Get 要跳转到的页面类型 0 : 腾讯电子签小程序个人首页 (默认) 1 : 腾讯电子签小程序流程合同的详情页 (即合同签署页面) 2 : 腾讯电子签小程序合同列表页
`void`	`setAgent(Agent Agent)`	Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setAutoJumpBack(Boolean AutoJumpBack)`	Set 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: ` 该参数只针对"APP" 类型的签署链接有效`
`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`	`setFlowId(String FlowId)`	Set 合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
`void`	`setHides(Long[] Hides)`	Set 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`void`	`setMobile(String Mobile)`	Set 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。
`void`	`setName(String Name)`	Set 合同流程里边签署方经办人的姓名。
`void`	`setOperator(UserInfo Operator)`	Set 执行本接口操作的员工信息, userId 必填。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`void`	`setOrganizationName(String OrganizationName)`	Set 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
`void`	`setPathType(Long PathType)`	Set 要跳转到的页面类型 0 : 腾讯电子签小程序个人首页 (默认) 1 : 腾讯电子签小程序流程合同的详情页 (即合同签署页面) 2 : 腾讯电子签小程序合同列表页
`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, 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 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
    
    Returns:
    
    OrganizationName 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
  - setOrganizationName
```
public void setOrganizationName(String OrganizationName)
```
    Set 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
    
    Parameters:
    
    OrganizationName - 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。
  - 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前缀或其他字符)。
  - 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** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)
    
    **2** : 腾讯电子签小程序合同列表页
    Returns:
    
    PathType 要跳转到的页面类型
    **0** : 腾讯电子签小程序个人首页 (默认)
    
    **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)
    
    **2** : 腾讯电子签小程序合同列表页
  - setPathType
```
public void setPathType(Long PathType)
```
    Set 要跳转到的页面类型
    **0** : 腾讯电子签小程序个人首页 (默认)
    
    **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)
    
    **2** : 腾讯电子签小程序合同列表页
    Parameters:
    
    PathType - 要跳转到的页面类型
    **0** : 腾讯电子签小程序个人首页 (默认)
    
    **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)
    
    **2** : 腾讯电子签小程序合同列表页
  - getAutoJumpBack
```
public Boolean getAutoJumpBack()
```
    Get 签署完成后是否自动回跳
    **false**：否, 签署完成不会自动跳转回来(默认)
    **true**：是, 签署完成会自动跳转回来
    注: ` 该参数只针对"APP" 类型的签署链接有效`
    Returns:
    
    AutoJumpBack 签署完成后是否自动回跳
    **false**：否, 签署完成不会自动跳转回来(默认)
    **true**：是, 签署完成会自动跳转回来
    注: ` 该参数只针对"APP" 类型的签署链接有效`
  - setAutoJumpBack
```
public void setAutoJumpBack(Boolean AutoJumpBack)
```
    Set 签署完成后是否自动回跳
    **false**：否, 签署完成不会自动跳转回来(默认)
    **true**：是, 签署完成会自动跳转回来
    注: ` 该参数只针对"APP" 类型的签署链接有效`
    Parameters:
    
    AutoJumpBack - 签署完成后是否自动回跳
    **false**：否, 签署完成不会自动跳转回来(默认)
    **true**：是, 签署完成会自动跳转回来
    注: ` 该参数只针对"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** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
  - 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 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

getEndPoint

setEndPoint

getFlowId

setFlowId

getFlowGroupId

setFlowGroupId

getPathType

setPathType

getAutoJumpBack

setAutoJumpBack

getAgent

setAgent

getHides

setHides

toMap