public class ChannelCreateEmbedWebUrlRequest extends AbstractModel
header, skipSign
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.
|
Modifier and Type | Method and Description |
---|---|
Agent |
getAgent()
Get 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: 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.
|
String |
getUserData()
Get 用户自定义参数
目前仅支持EmbedType=CREATE_TEMPLATE时传入
指定后,创建,编辑,删除模板时,回调都会携带该userData
支持的格式:json字符串的BASE64编码字符串
示例:
json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9
eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式
|
void |
setAgent(Agent Agent)
Set 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: 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 |
setUserData(String UserData)
Set 用户自定义参数
目前仅支持EmbedType=CREATE_TEMPLATE时传入
指定后,创建,编辑,删除模板时,回调都会携带该userData
支持的格式:json字符串的BASE64编码字符串
示例:
json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9
eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public ChannelCreateEmbedWebUrlRequest()
public ChannelCreateEmbedWebUrlRequest(ChannelCreateEmbedWebUrlRequest source)
public Agent getAgent()
public void setAgent(Agent Agent)
Agent
- 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
public String getEmbedType()
public void setEmbedType(String EmbedType)
EmbedType
- 要生成WEB嵌入界面的类型, 可以选择的值如下:
public String getBusinessId()
public void setBusinessId(String BusinessId)
BusinessId
- WEB嵌入的业务资源ID
public Boolean getHiddenComponents()
public void setHiddenComponents(Boolean HiddenComponents)
HiddenComponents
- 是否隐藏控件,只有预览模板时生效@Deprecated public UserInfo getOperator()
@Deprecated public void setOperator(UserInfo Operator)
Operator
- 渠道操作者信息public String getUserData()
public void setUserData(String UserData)
UserData
- 用户自定义参数
Copyright © 2023. All rights reserved.