ChannelCreateFlowByFilesRequest (tencentcloud-sdk-java 3.1.784 API)

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

public class ChannelCreateFlowByFilesRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`ChannelCreateFlowByFilesRequest()`
`ChannelCreateFlowByFilesRequest(ChannelCreateFlowByFilesRequest 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.ProxyOrganizationOpenId、Agent.
`String`	`getApproverVerifyType()` Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`String`	`getAutoSignScene()` Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
`String`	`getCallbackUrl()` Get 签署流程回调地址，长度不超过255个字符
`CcInfo[]`	`getCcInfos()` Get 被抄送人信息列表
`Long`	`getCcNotifyType()` Get 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
`Component[]`	`getComponents()` Get 签署文件中的发起方的填写控件，需要在发起的时候进行填充
`String`	`getCustomerData()` Get 业务信息，最大长度1000个字符。
`String`	`getCustomShowMap()` Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
`Long`	`getDeadline()` Get 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
`String[]`	`getFileIds()` Get 签署文件资源Id列表，目前仅支持单个文件
`FlowApproverInfo[]`	`getFlowApprovers()` Get 签署流程签约方列表，最多不超过50个参与方
`String`	`getFlowDescription()` Get 签署流程的描述，长度不超过1000个字符
`String`	`getFlowName()` Get 签署流程名称，长度不超过200个字符
`String`	`getFlowType()` Get 签署流程的类型，长度不超过255个字符
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
`UserInfo`	`getOperator()` Deprecated.
`Long`	`getSignBeanTag()` Get 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
`Boolean`	`getUnordered()` Get 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
`void`	`setAgent(Agent Agent)` Set 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent.
`void`	`setApproverVerifyType(String ApproverVerifyType)` Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`void`	`setAutoSignScene(String AutoSignScene)` Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
`void`	`setCallbackUrl(String CallbackUrl)` Set 签署流程回调地址，长度不超过255个字符
`void`	`setCcInfos(CcInfo[] CcInfos)` Set 被抄送人信息列表
`void`	`setCcNotifyType(Long CcNotifyType)` Set 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
`void`	`setComponents(Component[] Components)` Set 签署文件中的发起方的填写控件，需要在发起的时候进行填充
`void`	`setCustomerData(String CustomerData)` Set 业务信息，最大长度1000个字符。
`void`	`setCustomShowMap(String CustomShowMap)` Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
`void`	`setDeadline(Long Deadline)` Set 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
`void`	`setFileIds(String[] FileIds)` Set 签署文件资源Id列表，目前仅支持单个文件
`void`	`setFlowApprovers(FlowApproverInfo[] FlowApprovers)` Set 签署流程签约方列表，最多不超过50个参与方
`void`	`setFlowDescription(String FlowDescription)` Set 签署流程的描述，长度不超过1000个字符
`void`	`setFlowName(String FlowName)` Set 签署流程名称，长度不超过200个字符
`void`	`setFlowType(String FlowType)` Set 签署流程的类型，长度不超过255个字符
`void`	`setNeedSignReview(Boolean NeedSignReview)` Set 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
`void`	`setOperator(UserInfo Operator)` Deprecated.
`void`	`setSignBeanTag(Long SignBeanTag)` Set 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
`void`	`setUnordered(Boolean Unordered)` Set 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
`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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChannelCreateFlowByFilesRequest
```
public ChannelCreateFlowByFilesRequest()
```
  - ChannelCreateFlowByFilesRequest
```
public ChannelCreateFlowByFilesRequest(ChannelCreateFlowByFilesRequest 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.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    
    Returns:
    
    Agent 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    
    Parameters:
    
    Agent - 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
  - getFlowName
```
public String getFlowName()
```
    Get 签署流程名称，长度不超过200个字符
    
    Returns:
    
    FlowName 签署流程名称，长度不超过200个字符
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 签署流程名称，长度不超过200个字符
    
    Parameters:
    
    FlowName - 签署流程名称，长度不超过200个字符
  - getFlowApprovers
```
public FlowApproverInfo[] getFlowApprovers()
```
    Get 签署流程签约方列表，最多不超过50个参与方
    
    Returns:
    
    FlowApprovers 签署流程签约方列表，最多不超过50个参与方
  - setFlowApprovers
```
public void setFlowApprovers(FlowApproverInfo[] FlowApprovers)
```
    Set 签署流程签约方列表，最多不超过50个参与方
    
    Parameters:
    
    FlowApprovers - 签署流程签约方列表，最多不超过50个参与方
  - getFileIds
```
public String[] getFileIds()
```
    Get 签署文件资源Id列表，目前仅支持单个文件
    
    Returns:
    
    FileIds 签署文件资源Id列表，目前仅支持单个文件
  - setFileIds
```
public void setFileIds(String[] FileIds)
```
    Set 签署文件资源Id列表，目前仅支持单个文件
    
    Parameters:
    
    FileIds - 签署文件资源Id列表，目前仅支持单个文件
  - getComponents
```
public Component[] getComponents()
```
    Get 签署文件中的发起方的填写控件，需要在发起的时候进行填充
    
    Returns:
    
    Components 签署文件中的发起方的填写控件，需要在发起的时候进行填充
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 签署文件中的发起方的填写控件，需要在发起的时候进行填充
    
    Parameters:
    
    Components - 签署文件中的发起方的填写控件，需要在发起的时候进行填充
  - getDeadline
```
public Long getDeadline()
```
    Get 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
    
    Returns:
    
    Deadline 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
    
    Parameters:
    
    Deadline - 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
  - getCallbackUrl
```
public String getCallbackUrl()
```
    Get 签署流程回调地址，长度不超过255个字符
    
    Returns:
    
    CallbackUrl 签署流程回调地址，长度不超过255个字符
  - setCallbackUrl
```
public void setCallbackUrl(String CallbackUrl)
```
    Set 签署流程回调地址，长度不超过255个字符
    
    Parameters:
    
    CallbackUrl - 签署流程回调地址，长度不超过255个字符
  - getUnordered
```
public Boolean getUnordered()
```
    Get 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
    
    Returns:
    
    Unordered 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
    
    Parameters:
    
    Unordered - 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
  - getFlowType
```
public String getFlowType()
```
    Get 签署流程的类型，长度不超过255个字符
    
    Returns:
    
    FlowType 签署流程的类型，长度不超过255个字符
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 签署流程的类型，长度不超过255个字符
    
    Parameters:
    
    FlowType - 签署流程的类型，长度不超过255个字符
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 签署流程的描述，长度不超过1000个字符
    
    Returns:
    
    FlowDescription 签署流程的描述，长度不超过1000个字符
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 签署流程的描述，长度不超过1000个字符
    
    Parameters:
    
    FlowDescription - 签署流程的描述，长度不超过1000个字符
  - getCustomShowMap
```
public String getCustomShowMap()
```
    Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
    
    Returns:
    
    CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
  - setCustomShowMap
```
public void setCustomShowMap(String CustomShowMap)
```
    Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
    
    Parameters:
    
    CustomShowMap - 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
  - getCustomerData
```
public String getCustomerData()
```
    Get 业务信息，最大长度1000个字符。
    
    Returns:
    
    CustomerData 业务信息，最大长度1000个字符。
  - setCustomerData
```
public void setCustomerData(String CustomerData)
```
    Set 业务信息，最大长度1000个字符。
    
    Parameters:
    
    CustomerData - 业务信息，最大长度1000个字符。
  - getNeedSignReview
```
public Boolean getNeedSignReview()
```
    Get 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
    
    Returns:
    
    NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
  - setNeedSignReview
```
public void setNeedSignReview(Boolean NeedSignReview)
```
    Set 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
    
    Parameters:
    
    NeedSignReview - 发起方企业的签署人进行签署操作是否需要企业内部审批。若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
  - getApproverVerifyType
```
public String getApproverVerifyType()
```
    Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Returns:
    
    ApproverVerifyType 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - setApproverVerifyType
```
public void setApproverVerifyType(String ApproverVerifyType)
```
    Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Parameters:
    
    ApproverVerifyType - 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - getSignBeanTag
```
public Long getSignBeanTag()
```
    Get 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
    
    Returns:
    
    SignBeanTag 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
  - setSignBeanTag
```
public void setSignBeanTag(Long SignBeanTag)
```
    Set 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
    
    Parameters:
    
    SignBeanTag - 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
  - getCcInfos
```
public CcInfo[] getCcInfos()
```
    Get 被抄送人信息列表
    
    Returns:
    
    CcInfos 被抄送人信息列表
  - setCcInfos
```
public void setCcInfos(CcInfo[] CcInfos)
```
    Set 被抄送人信息列表
    
    Parameters:
    
    CcInfos - 被抄送人信息列表
  - getCcNotifyType
```
public Long getCcNotifyType()
```
    Get 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
    
    Returns:
    
    CcNotifyType 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
  - setCcNotifyType
```
public void setCcNotifyType(Long CcNotifyType)
```
    Set 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
    
    Parameters:
    
    CcNotifyType - 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
  - getAutoSignScene
```
public String getAutoSignScene()
```
    Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
    
    Returns:
    
    AutoSignScene 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
  - setAutoSignScene
```
public void setAutoSignScene(String AutoSignScene)
```
    Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
    
    Parameters:
    
    AutoSignScene - 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
  - 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 ChannelCreateFlowByFilesRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

ChannelCreateFlowByFilesRequest

ChannelCreateFlowByFilesRequest

Method Detail

getAgent

setAgent

getFlowName

setFlowName

getFlowApprovers

setFlowApprovers

getFileIds

setFileIds

getComponents

setComponents

getDeadline

setDeadline

getCallbackUrl

setCallbackUrl

getUnordered

setUnordered

getFlowType

setFlowType

getFlowDescription

setFlowDescription

getCustomShowMap

setCustomShowMap

getCustomerData

setCustomerData

getNeedSignReview

setNeedSignReview

getApproverVerifyType

setApproverVerifyType

getSignBeanTag

setSignBeanTag

getCcInfos

setCcInfos

getCcNotifyType

setCcNotifyType

getAutoSignScene

setAutoSignScene

getOperator

setOperator

toMap