com.tencentcloudapi.essbasic.v20210526.models

Class ChannelCreateEmbedWebUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateEmbedWebUrlRequest

public class ChannelCreateEmbedWebUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
ChannelCreateEmbedWebUrlRequest()
ChannelCreateEmbedWebUrlRequest(ChannelCreateEmbedWebUrlRequest 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.
String	getBusinessId() Get WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
String	getEmbedType() Get 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面
Boolean	getHiddenComponents() Get 是否隐藏控件，只有预览模板时生效
UserInfo	getOperator() Deprecated.
void	setAgent(Agent Agent) Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent.
void	setBusinessId(String BusinessId) Set WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
void	setEmbedType(String EmbedType) Set 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面
void	setHiddenComponents(Boolean HiddenComponents) Set 是否隐藏控件，只有预览模板时生效
void	setOperator(UserInfo Operator) Deprecated.
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, getSkipSign, set, 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

ChannelCreateEmbedWebUrlRequest

public ChannelCreateEmbedWebUrlRequest()

ChannelCreateEmbedWebUrlRequest

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

Returns:

Agent 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

setAgent

public void setAgent(Agent Agent)

Set 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

Parameters:

Agent - 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

getEmbedType

public String getEmbedType()

Get 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面

Returns:

EmbedType 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面

setEmbedType

public void setEmbedType(String EmbedType)

Set 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面

Parameters:

EmbedType - 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE：生成创建模板的嵌入页面 - MODIFY_TEMPLATE：生成修改模板的嵌入页面 - PREVIEW_TEMPLATE：生成预览模板的嵌入页面 - PREVIEW_FLOW：生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 - EXTEND_SERVICE：生成扩展服务的嵌入页面

getBusinessId

public String getBusinessId()

Get WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId

Returns:

BusinessId WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId

setBusinessId

public void setBusinessId(String BusinessId)

Set WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId

Parameters:

BusinessId - WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId

getHiddenComponents

public Boolean getHiddenComponents()

Get 是否隐藏控件，只有预览模板时生效

Returns:

HiddenComponents 是否隐藏控件，只有预览模板时生效

setHiddenComponents

public void setHiddenComponents(Boolean HiddenComponents)

Set 是否隐藏控件，只有预览模板时生效

Parameters:

HiddenComponents - 是否隐藏控件，只有预览模板时生效

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