public class CreateEmbedWebUrlRequest extends AbstractModel
header, skipSign| Constructor and Description |
|---|
CreateEmbedWebUrlRequest() |
CreateEmbedWebUrlRequest(CreateEmbedWebUrlRequest 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 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
String |
getBusinessId()
Get WEB嵌入的业务资源ID
当EmbedType取值
为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。
注意：
1.
|
String |
getEmbedType()
Get WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
|
UserInfo |
getOperator()
Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` |
EmbedUrlOption |
getOption()
Get 个性化参数，用于控制页面展示内容
|
ReviewerInfo |
getReviewer()
Get 抄送方信息
|
String |
getUserData()
Get 目前仅支持EmbedType=CREATE_TEMPLATE时传入 指定后，创建，编辑，删除模板时，回调都会携带该userData 支持的格式：json字符串的BASE64编码字符串 示例： json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9 eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
|
void |
setAgent(Agent Agent)
Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
void |
setBusinessId(String BusinessId)
Set WEB嵌入的业务资源ID
当EmbedType取值
为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。
注意：
1.
|
void |
setEmbedType(String EmbedType)
Set WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
|
void |
setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` |
void |
setOption(EmbedUrlOption Option)
Set 个性化参数，用于控制页面展示内容
|
void |
setReviewer(ReviewerInfo Reviewer)
Set 抄送方信息
|
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, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic CreateEmbedWebUrlRequest()
public CreateEmbedWebUrlRequest(CreateEmbedWebUrlRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator - 执行本接口操作的员工信息。
public String getEmbedType()
public void setEmbedType(String EmbedType)
EmbedType - WEB嵌入资源类型，支持以下类型
public String getBusinessId()
public void setBusinessId(String BusinessId)
BusinessId - WEB嵌入的业务资源ID
当EmbedType取值
public Agent getAgent()
public void setAgent(Agent Agent)
Agent - 代理企业和员工的信息。
public ReviewerInfo getReviewer()
public void setReviewer(ReviewerInfo Reviewer)
Reviewer - 抄送方信息public EmbedUrlOption getOption()
public void setOption(EmbedUrlOption Option)
Option - 个性化参数，用于控制页面展示内容public String getUserData()
public void setUserData(String UserData)
UserData - Copyright © 2024. All rights reserved.