CreateFlowByFilesRequest (tencentcloud-sdk-java 3.1.689 API)

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

public class CreateFlowByFilesRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`CreateFlowByFilesRequest()`
`CreateFlowByFilesRequest(CreateFlowByFilesRequest 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 应用号信息
`ApproverInfo[]`	`getApprovers()` Get 签署参与者信息，最大限制50方
`String`	`getApproverVerifyType()` Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`CcInfo[]`	`getCcInfos()` Get 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
`Component[]`	`getComponents()` Get 经办人内容控件配置
`String`	`getCustomShowMap()` Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
`Long`	`getDeadline()` Get 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
`String[]`	`getFileIds()` Get 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
`String`	`getFlowDescription()` Get 签署流程描述,最大长度1000个字符
`String`	`getFlowName()` Get 签署流程名称,最大长度200个字符
`String`	`getFlowType()` Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
`Boolean`	`getNeedPreview()` Get 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
`Boolean`	`getNeedSignReview()` Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
`UserInfo`	`getOperator()` Get 调用方用户信息，userId 必填
`Long`	`getPreviewType()` Get 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
`Long`	`getSignBeanTag()` Get 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
`Boolean`	`getUnordered()` Get 发送类型： true：无序签 false：有序签注：默认为false（有序签）
`String`	`getUserData()` Get 用户自定义字段，回调的时候会进行透传，长度需要小于20480
`void`	`setAgent(Agent Agent)` Set 应用号信息
`void`	`setApprovers(ApproverInfo[] Approvers)` Set 签署参与者信息，最大限制50方
`void`	`setApproverVerifyType(String ApproverVerifyType)` Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
`void`	`setCcInfos(CcInfo[] CcInfos)` Set 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
`void`	`setComponents(Component[] Components)` Set 经办人内容控件配置
`void`	`setCustomShowMap(String CustomShowMap)` Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
`void`	`setDeadline(Long Deadline)` Set 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
`void`	`setFileIds(String[] FileIds)` Set 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
`void`	`setFlowDescription(String FlowDescription)` Set 签署流程描述,最大长度1000个字符
`void`	`setFlowName(String FlowName)` Set 签署流程名称,最大长度200个字符
`void`	`setFlowType(String FlowType)` Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
`void`	`setNeedPreview(Boolean NeedPreview)` Set 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
`void`	`setNeedSignReview(Boolean NeedSignReview)` Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
`void`	`setOperator(UserInfo Operator)` Set 调用方用户信息，userId 必填
`void`	`setPreviewType(Long PreviewType)` Set 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
`void`	`setSignBeanTag(Long SignBeanTag)` Set 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
`void`	`setUnordered(Boolean Unordered)` Set 发送类型： true：无序签 false：有序签注：默认为false（有序签）
`void`	`setUserData(String UserData)` Set 用户自定义字段，回调的时候会进行透传，长度需要小于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, 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
  - CreateFlowByFilesRequest
```
public CreateFlowByFilesRequest()
```
  - CreateFlowByFilesRequest
```
public CreateFlowByFilesRequest(CreateFlowByFilesRequest 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 必填
  - getFlowName
```
public String getFlowName()
```
    Get 签署流程名称,最大长度200个字符
    
    Returns:
    
    FlowName 签署流程名称,最大长度200个字符
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 签署流程名称,最大长度200个字符
    
    Parameters:
    
    FlowName - 签署流程名称,最大长度200个字符
  - getApprovers
```
public ApproverInfo[] getApprovers()
```
    Get 签署参与者信息，最大限制50方
    
    Returns:
    
    Approvers 签署参与者信息，最大限制50方
  - setApprovers
```
public void setApprovers(ApproverInfo[] Approvers)
```
    Set 签署参与者信息，最大限制50方
    
    Parameters:
    
    Approvers - 签署参与者信息，最大限制50方
  - getFileIds
```
public String[] getFileIds()
```
    Get 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
    
    Returns:
    
    FileIds 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
  - setFileIds
```
public void setFileIds(String[] FileIds)
```
    Set 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
    
    Parameters:
    
    FileIds - 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
  - getFlowType
```
public String getFlowType()
```
    Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
    
    Returns:
    
    FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
    
    Parameters:
    
    FlowType - 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
  - getComponents
```
public Component[] getComponents()
```
    Get 经办人内容控件配置
    
    Returns:
    
    Components 经办人内容控件配置
  - setComponents
```
public void setComponents(Component[] Components)
```
    Set 经办人内容控件配置
    
    Parameters:
    
    Components - 经办人内容控件配置
  - getCcInfos
```
public CcInfo[] getCcInfos()
```
    Get 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
    
    Returns:
    
    CcInfos 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
  - setCcInfos
```
public void setCcInfos(CcInfo[] CcInfos)
```
    Set 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
    
    Parameters:
    
    CcInfos - 被抄送人的信息列表。注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
  - getNeedPreview
```
public Boolean getNeedPreview()
```
    Get 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
    
    Returns:
    
    NeedPreview 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
  - setNeedPreview
```
public void setNeedPreview(Boolean NeedPreview)
```
    Set 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
    
    Parameters:
    
    NeedPreview - 是否需要预览，true：预览模式，false：非预览（默认）；预览链接有效期300秒；注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
  - getPreviewType
```
public Long getPreviewType()
```
    Get 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
    
    Returns:
    
    PreviewType 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
  - setPreviewType
```
public void setPreviewType(Long PreviewType)
```
    Set 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
    
    Parameters:
    
    PreviewType - 预览链接类型默认:0-文件流, 1- H5链接注意:此参数在NeedPreview 为true 时有效,
  - getDeadline
```
public Long getDeadline()
```
    Get 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
    
    Returns:
    
    Deadline 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
    
    Parameters:
    
    Deadline - 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后
  - getUnordered
```
public Boolean getUnordered()
```
    Get 发送类型： true：无序签 false：有序签注：默认为false（有序签）
    
    Returns:
    
    Unordered 发送类型： true：无序签 false：有序签注：默认为false（有序签）
  - setUnordered
```
public void setUnordered(Boolean Unordered)
```
    Set 发送类型： true：无序签 false：有序签注：默认为false（有序签）
    
    Parameters:
    
    Unordered - 发送类型： true：无序签 false：有序签注：默认为false（有序签）
  - 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开始
  - getNeedSignReview
```
public Boolean getNeedSignReview()
```
    Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
    
    Returns:
    
    NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
  - setNeedSignReview
```
public void setNeedSignReview(Boolean NeedSignReview)
```
    Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
    
    Parameters:
    
    NeedSignReview - 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
  - getUserData
```
public String getUserData()
```
    Get 用户自定义字段，回调的时候会进行透传，长度需要小于20480
    
    Returns:
    
    UserData 用户自定义字段，回调的时候会进行透传，长度需要小于20480
  - setUserData
```
public void setUserData(String UserData)
```
    Set 用户自定义字段，回调的时候会进行透传，长度需要小于20480
    
    Parameters:
    
    UserData - 用户自定义字段，回调的时候会进行透传，长度需要小于20480
  - getAgent
```
public Agent getAgent()
```
    Get 应用号信息
    
    Returns:
    
    Agent 应用号信息
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 应用号信息
    
    Parameters:
    
    Agent - 应用号信息
  - getApproverVerifyType
```
public String getApproverVerifyType()
```
    Get 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Returns:
    
    ApproverVerifyType 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - setApproverVerifyType
```
public void setApproverVerifyType(String ApproverVerifyType)
```
    Set 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    
    Parameters:
    
    ApproverVerifyType - 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 签署流程描述,最大长度1000个字符
    
    Returns:
    
    FlowDescription 签署流程描述,最大长度1000个字符
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 签署流程描述,最大长度1000个字符
    
    Parameters:
    
    FlowDescription - 签署流程描述,最大长度1000个字符
  - 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，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
  - 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 CreateFlowByFilesRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateFlowByFilesRequest

CreateFlowByFilesRequest

Method Detail

getOperator

setOperator

getFlowName

setFlowName

getApprovers

setApprovers

getFileIds

setFileIds

getFlowType

setFlowType

getComponents

setComponents

getCcInfos

setCcInfos

getNeedPreview

setNeedPreview

getPreviewType

setPreviewType

getDeadline

setDeadline

getUnordered

setUnordered

getCustomShowMap

setCustomShowMap

getNeedSignReview

setNeedSignReview

getUserData

setUserData

getAgent

setAgent

getApproverVerifyType

setApproverVerifyType

getFlowDescription

setFlowDescription

getSignBeanTag

setSignBeanTag

toMap