CreateMultiFlowSignQRCodeRequest (tencentcloud-sdk-java 3.1.1139 API)

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

public class CreateMultiFlowSignQRCodeRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CreateMultiFlowSignQRCodeRequest()`
`CreateMultiFlowSignQRCodeRequest(CreateMultiFlowSignQRCodeRequest 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）为必填项。
`ApproverComponentLimitType[]`	`getApproverComponentLimitTypes()` Get 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
`ApproverRestriction`	`getApproverRestrictions()` Deprecated.
`String`	`getCallbackUrl()` Deprecated.
`Long`	`getFlowEffectiveDay()` Get 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
`String`	`getFlowName()` Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
`Boolean`	`getForbidPersonalMultipleSign()` Get 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
`Long`	`getMaxFlowNum()` Get 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
`UserInfo`	`getOperator()` Get 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`Long`	`getQrEffectiveDay()` Get 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
`ApproverRestriction[]`	`getRestrictions()` Get 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
`String`	`getTemplateId()` Get 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
`String`	`getUserData()` Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`void`	`setAgent(Agent Agent)` Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setApproverComponentLimitTypes(ApproverComponentLimitType[] ApproverComponentLimitTypes)` Set 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
`void`	`setApproverRestrictions(ApproverRestriction ApproverRestrictions)` Deprecated.
`void`	`setCallbackUrl(String CallbackUrl)` Deprecated.
`void`	`setFlowEffectiveDay(Long FlowEffectiveDay)` Set 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
`void`	`setFlowName(String FlowName)` Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
`void`	`setForbidPersonalMultipleSign(Boolean ForbidPersonalMultipleSign)` Set 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
`void`	`setMaxFlowNum(Long MaxFlowNum)` Set 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
`void`	`setOperator(UserInfo Operator)` Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`void`	`setQrEffectiveDay(Long QrEffectiveDay)` Set 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
`void`	`setRestrictions(ApproverRestriction[] Restrictions)` Set 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
`void`	`setTemplateId(String TemplateId)` Set 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
`void`	`setUserData(String UserData)` Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
`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
  - CreateMultiFlowSignQRCodeRequest
```
public CreateMultiFlowSignQRCodeRequest()
```
  - CreateMultiFlowSignQRCodeRequest
```
public CreateMultiFlowSignQRCodeRequest(CreateMultiFlowSignQRCodeRequest 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 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Returns:
    
    Operator 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - setOperator
```
public void setOperator(UserInfo Operator)
```
    Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Parameters:
    
    Operator - 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - getTemplateId
```
public String getTemplateId()
```
    Get 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    
    Returns:
    
    TemplateId 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
  - setTemplateId
```
public void setTemplateId(String TemplateId)
```
    Set 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    
    Parameters:
    
    TemplateId - 合同模板ID，为32位字符串。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
  - getFlowName
```
public String getFlowName()
```
    Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
    
    Returns:
    
    FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
    
    Parameters:
    
    FlowName - 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
  - getMaxFlowNum
```
public Long getMaxFlowNum()
```
    Get 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
    
    Returns:
    
    MaxFlowNum 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
  - setMaxFlowNum
```
public void setMaxFlowNum(Long MaxFlowNum)
```
    Set 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
    
    Parameters:
    
    MaxFlowNum - 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
  - getQrEffectiveDay
```
public Long getQrEffectiveDay()
```
    Get 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
    
    Returns:
    
    QrEffectiveDay 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
  - setQrEffectiveDay
```
public void setQrEffectiveDay(Long QrEffectiveDay)
```
    Set 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
    
    Parameters:
    
    QrEffectiveDay - 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
  - getFlowEffectiveDay
```
public Long getFlowEffectiveDay()
```
    Get 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
    
    Returns:
    
    FlowEffectiveDay 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
  - setFlowEffectiveDay
```
public void setFlowEffectiveDay(Long FlowEffectiveDay)
```
    Set 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
    
    Parameters:
    
    FlowEffectiveDay - 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
  - getRestrictions
```
public ApproverRestriction[] getRestrictions()
```
    Get 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
    
    Returns:
    
    Restrictions 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
  - setRestrictions
```
public void setRestrictions(ApproverRestriction[] Restrictions)
```
    Set 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
    
    Parameters:
    
    Restrictions - 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
  - getUserData
```
public String getUserData()
```
    Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Returns:
    
    UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - setUserData
```
public void setUserData(String UserData)
```
    Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
    
    Parameters:
    
    UserData - 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
    通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
    
    Returns:
    
    CallbackUrl 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
    通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String CallbackUrl)
```
    Deprecated.
    
    Set 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
    通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
    
    Parameters:
    
    CallbackUrl - 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
    通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
  - getAgent
```
public Agent getAgent()
```
    Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Returns:
    
    Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Parameters:
    
    Agent - 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - getApproverRestrictions
```
@Deprecated
public ApproverRestriction getApproverRestrictions()
```
    Deprecated.
    
    Get 限制二维码用户条件（已弃用）
    
    Returns:
    
    ApproverRestrictions 限制二维码用户条件（已弃用）
  - setApproverRestrictions
```
@Deprecated
public void setApproverRestrictions(ApproverRestriction ApproverRestrictions)
```
    Deprecated.
    
    Set 限制二维码用户条件（已弃用）
    
    Parameters:
    
    ApproverRestrictions - 限制二维码用户条件（已弃用）
  - getApproverComponentLimitTypes
```
public ApproverComponentLimitType[] getApproverComponentLimitTypes()
```
    Get 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
    
    Returns:
    
    ApproverComponentLimitTypes 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
  - setApproverComponentLimitTypes
```
public void setApproverComponentLimitTypes(ApproverComponentLimitType[] ApproverComponentLimitTypes)
```
    Set 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
    
    Parameters:
    
    ApproverComponentLimitTypes - 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE）时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
  - getForbidPersonalMultipleSign
```
public Boolean getForbidPersonalMultipleSign()
```
    Get 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
    
    Returns:
    
    ForbidPersonalMultipleSign 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
  - setForbidPersonalMultipleSign
```
public void setForbidPersonalMultipleSign(Boolean ForbidPersonalMultipleSign)
```
    Set 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
    
    Parameters:
    
    ForbidPersonalMultipleSign - 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
  - 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 CreateMultiFlowSignQRCodeRequest

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

CreateMultiFlowSignQRCodeRequest

CreateMultiFlowSignQRCodeRequest

Method Detail

getOperator

setOperator

getTemplateId

setTemplateId

getFlowName

setFlowName

getMaxFlowNum

setMaxFlowNum

getQrEffectiveDay

setQrEffectiveDay

getFlowEffectiveDay

setFlowEffectiveDay

getRestrictions

setRestrictions

getUserData

setUserData

getCallbackUrl

setCallbackUrl

getAgent

setAgent

getApproverRestrictions

setApproverRestrictions

getApproverComponentLimitTypes

setApproverComponentLimitTypes

getForbidPersonalMultipleSign

setForbidPersonalMultipleSign

toMap