com.tencentcloudapi.ess.v20201111.models

Class CreateFlowByFilesRequest

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

Modifier and Type	Method and Description
Agent	getAgent() Get 应用号信息
ApproverInfo[]	getApprovers() Get 签署参与者信息
CcInfo[]	getCcInfos() Get 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
Component[]	getComponents() Get 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12
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秒；
UserInfo	getOperator() Get 调用方用户信息
Boolean	getUnordered() Get 发送类型： true：无序签 false：有序签 注：默认为false（有序签）
void	setAgent(Agent Agent) Set 应用号信息
void	setApprovers(ApproverInfo[] Approvers) Set 签署参与者信息
void	setCcInfos(CcInfo[] CcInfos) Set 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
void	setComponents(Component[] Components) Set 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12
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秒；
void	setOperator(UserInfo Operator) Set 调用方用户信息
void	setUnordered(Boolean Unordered) Set 发送类型： true：无序签 false：有序签 注：默认为false（有序签）
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

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 签署参与者信息

Returns:

Approvers 签署参与者信息

setApprovers

public void setApprovers(ApproverInfo[] Approvers)

Set 签署参与者信息

Parameters:

Approvers - 签署参与者信息

getFileIds

public String[] getFileIds()

Get 签署pdf文件的资源编号列表，通过UploadFiles接口获取

Returns:

FileIds 签署pdf文件的资源编号列表，通过UploadFiles接口获取

setFileIds

public void setFileIds(String[] FileIds)

Set 签署pdf文件的资源编号列表，通过UploadFiles接口获取

Parameters:

FileIds - 签署pdf文件的资源编号列表，通过UploadFiles接口获取

getOperator

public UserInfo getOperator()

Get 调用方用户信息

Returns:

Operator 调用方用户信息

setOperator

public void setOperator(UserInfo Operator)

Set 调用方用户信息

Parameters:

Operator - 调用方用户信息

getAgent

public Agent getAgent()

Get 应用号信息

Returns:

Agent 应用号信息

setAgent

public void setAgent(Agent Agent)

Set 应用号信息

Parameters:

Agent - 应用号信息

getComponents

public Component[] getComponents()

Get 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12

Returns:

Components 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12

setComponents

public void setComponents(Component[] Components)

Set 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12

Parameters:

Components - 经办人内容控件配置。可选类型为： TEXT - 内容文本控件 MULTI_LINE_TEXT - 多行文本控件 CHECK_BOX - 勾选框控件 ATTACHMENT - 附件 注：默认字体大小为 字号12

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（有序签）

getNeedPreview

public Boolean getNeedPreview()

Get 是否需要预览，true：预览模式，false：非预览（默认）； 预览链接有效期300秒；

Returns:

NeedPreview 是否需要预览，true：预览模式，false：非预览（默认）； 预览链接有效期300秒；

setNeedPreview

public void setNeedPreview(Boolean NeedPreview)

Set 是否需要预览，true：预览模式，false：非预览（默认）； 预览链接有效期300秒；

Parameters:

NeedPreview - 是否需要预览，true：预览模式，false：非预览（默认）； 预览链接有效期300秒；

getFlowDescription

public String getFlowDescription()

Get 签署流程描述,最大长度1000个字符

Returns:

FlowDescription 签署流程描述,最大长度1000个字符

setFlowDescription

public void setFlowDescription(String FlowDescription)

Set 签署流程描述,最大长度1000个字符

Parameters:

FlowDescription - 签署流程描述,最大长度1000个字符

getFlowType

public String getFlowType()

Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

Returns:

FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

setFlowType

public void setFlowType(String FlowType)

Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

Parameters:

FlowType - 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

getCcInfos

public CcInfo[] getCcInfos()

Get 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用

Returns:

CcInfos 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用

setCcInfos

public void setCcInfos(CcInfo[] CcInfos)

Set 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用

Parameters:

CcInfos - 被抄送人的信息列表。 注:此功能为白名单功能，若有需要，请联系电子签客服开白使用

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开始

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel