com.tencentcloudapi.essbasic.v20210526.models

Class CreateFlowsByTemplatesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.CreateFlowsByTemplatesRequest

public class CreateFlowsByTemplatesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateFlowsByTemplatesRequest()
CreateFlowsByTemplatesRequest(CreateFlowsByTemplatesRequest 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 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.
FlowInfo[]	getFlowInfos() Get 多个合同（签署流程）信息，最多支持20个
Boolean	getNeedPreview() Get 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；
UserInfo	getOperator() Get 操作者的信息，不用传
Long	getPreviewType() Get 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
void	setAgent(Agent Agent) Set 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.
void	setFlowInfos(FlowInfo[] FlowInfos) Set 多个合同（签署流程）信息，最多支持20个
void	setNeedPreview(Boolean NeedPreview) Set 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；
void	setOperator(UserInfo Operator) Set 操作者的信息，不用传
void	setPreviewType(Long PreviewType) Set 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
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

CreateFlowsByTemplatesRequest

public CreateFlowsByTemplatesRequest()

CreateFlowsByTemplatesRequest

public CreateFlowsByTemplatesRequest(CreateFlowsByTemplatesRequest 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 均必填。

getFlowInfos

public FlowInfo[] getFlowInfos()

Get 多个合同（签署流程）信息，最多支持20个

Returns:

FlowInfos 多个合同（签署流程）信息，最多支持20个

setFlowInfos

public void setFlowInfos(FlowInfo[] FlowInfos)

Set 多个合同（签署流程）信息，最多支持20个

Parameters:

FlowInfos - 多个合同（签署流程）信息，最多支持20个

getNeedPreview

public Boolean getNeedPreview()

Get 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；

Returns:

NeedPreview 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；

setNeedPreview

public void setNeedPreview(Boolean NeedPreview)

Set 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；

Parameters:

NeedPreview - 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls； 预览链接有效期300秒； 同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；

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 时有效,

getOperator

public UserInfo getOperator()

Get 操作者的信息，不用传

Returns:

Operator 操作者的信息，不用传

setOperator

public void setOperator(UserInfo Operator)

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