ChannelCreateMultiFlowSignQRCodeRequest (tencentcloud-sdk-java 3.1.1121 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateMultiFlowSignQRCodeRequest

public class ChannelCreateMultiFlowSignQRCodeRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`ChannelCreateMultiFlowSignQRCodeRequest()`
`ChannelCreateMultiFlowSignQRCodeRequest(ChannelCreateMultiFlowSignQRCodeRequest 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 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
`ApproverComponentLimitType[]`	`getApproverComponentLimitTypes()` Get 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。
`ApproverRestriction`	`getApproverRestrictions()` Deprecated.
`String`	`getCallbackUrl()` Deprecated.
`Long`	`getFlowEffectiveDay()` Get 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
`String`	`getFlowName()` Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。
`Long`	`getMaxFlowNum()` Get 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
`UserInfo`	`getOperator()` Deprecated.
`Long`	`getQrEffectiveDay()` Get 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
`ApproverRestriction[]`	`getRestrictions()` Get 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
`String`	`getTemplateId()` Get 合同模板ID，为32位字符串。
`void`	`setAgent(Agent Agent)` Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.
`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`	`setMaxFlowNum(Long MaxFlowNum)` Set 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。一旦发起流程数超越该限制，该二维码将自动失效。
`void`	`setOperator(UserInfo Operator)` Deprecated.
`void`	`setQrEffectiveDay(Long QrEffectiveDay)` Set 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
`void`	`setRestrictions(ApproverRestriction[] Restrictions)` Set 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
`void`	`setTemplateId(String TemplateId)` Set 合同模板ID，为32位字符串。
`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
  - ChannelCreateMultiFlowSignQRCodeRequest
```
public ChannelCreateMultiFlowSignQRCodeRequest()
```
  - ChannelCreateMultiFlowSignQRCodeRequest
```
public ChannelCreateMultiFlowSignQRCodeRequest(ChannelCreateMultiFlowSignQRCodeRequest 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
  - getAgent
```
public Agent getAgent()
```
    Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    第三方平台子客企业和员工必须已经经过实名认证
    Returns:
    Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    
    第三方平台子客企业和员工必须已经经过实名认证
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    第三方平台子客企业和员工必须已经经过实名认证
    Parameters:
    Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
    
    第三方平台子客企业和员工必须已经经过实名认证
  - getTemplateId
```
public String getTemplateId()
```
    Get 合同模板ID，为32位字符串。
    
    Returns:
    
    TemplateId 合同模板ID，为32位字符串。
  - setTemplateId
```
public void setTemplateId(String TemplateId)
```
    Set 合同模板ID，为32位字符串。
    
    Parameters:
    
    TemplateId - 合同模板ID，为32位字符串。
  - 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份。一旦发起流程数超越该限制，该二维码将自动失效。
  - getFlowEffectiveDay
```
public Long getFlowEffectiveDay()
```
    Get 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
    
    Returns:
    
    FlowEffectiveDay 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
  - setFlowEffectiveDay
```
public void setFlowEffectiveDay(Long FlowEffectiveDay)
```
    Set 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
    
    Parameters:
    
    FlowEffectiveDay - 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。最长设定期限不得超过30天。
  - getQrEffectiveDay
```
public Long getQrEffectiveDay()
```
    Get 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
    
    Returns:
    
    QrEffectiveDay 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
  - setQrEffectiveDay
```
public void setQrEffectiveDay(Long QrEffectiveDay)
```
    Set 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
    
    Parameters:
    
    QrEffectiveDay - 二维码的有效期限，默认为7天，最高设定不得超过90天。一旦超过二维码的有效期限，该二维码将自动失效。
  - getRestrictions
```
public ApproverRestriction[] getRestrictions()
```
    Get 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
    
    Returns:
    
    Restrictions 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
  - setRestrictions
```
public void setRestrictions(ApproverRestriction[] Restrictions)
```
    Set 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
    
    Parameters:
    
    Restrictions - 指定签署人信息。在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
  - getApproverComponentLimitTypes
```
public ApproverComponentLimitType[] getApproverComponentLimitTypes()
```
    Get 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。
    
    Returns:
    
    ApproverComponentLimitTypes 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。
  - setApproverComponentLimitTypes
```
public void setApproverComponentLimitTypes(ApproverComponentLimitType[] ApproverComponentLimitTypes)
```
    Set 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。
    
    Parameters:
    
    ApproverComponentLimitTypes - 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    
    Get 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
    通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/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/partner/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/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/partner/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/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/partner/callback_types_contracts_sign
    用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/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
  - getApproverRestrictions
```
@Deprecated
public ApproverRestriction getApproverRestrictions()
```
    Deprecated.
    
    Get 限制二维码用户条件（已弃用）
    
    Returns:
    
    ApproverRestrictions 限制二维码用户条件（已弃用）
  - setApproverRestrictions
```
@Deprecated
public void setApproverRestrictions(ApproverRestriction ApproverRestrictions)
```
    Deprecated.
    
    Set 限制二维码用户条件（已弃用）
    
    Parameters:
    
    ApproverRestrictions - 限制二维码用户条件（已弃用）
  - getOperator
```
@Deprecated
public UserInfo getOperator()
```
    Deprecated.
    
    Get 暂未开放
    
    Returns:
    
    Operator 暂未开放
  - setOperator
```
@Deprecated
public void setOperator(UserInfo Operator)
```
    Deprecated.
    
    Set 暂未开放
    
    Parameters:
    
    Operator - 暂未开放
  - 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 ChannelCreateMultiFlowSignQRCodeRequest

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

ChannelCreateMultiFlowSignQRCodeRequest

ChannelCreateMultiFlowSignQRCodeRequest

Method Detail

getAgent

setAgent

getTemplateId

setTemplateId

getFlowName

setFlowName

getMaxFlowNum

setMaxFlowNum

getFlowEffectiveDay

setFlowEffectiveDay

getQrEffectiveDay

setQrEffectiveDay

getRestrictions

setRestrictions

getApproverComponentLimitTypes

setApproverComponentLimitTypes

getCallbackUrl

setCallbackUrl

getApproverRestrictions

setApproverRestrictions

getOperator

setOperator

toMap