Class StartFlowRequest
- java.lang.Object
-
- com.tencentcloudapi.common.AbstractModel
-
- com.tencentcloudapi.ess.v20201111.models.StartFlowRequest
-
public class StartFlowRequest extends AbstractModel
-
-
Field Summary
-
Fields inherited from class com.tencentcloudapi.common.AbstractModel
header, skipSign
-
-
Constructor Summary
Constructors Constructor Description StartFlowRequest()
StartFlowRequest(StartFlowRequest 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Agent
getAgent()
Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。Long
getCcNotifyType()
Get 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型: **0** :合同发起时通知通知对方来查看合同(默认) **1** : 签署完成后通知对方来查看合同String
getClientToken()
Deprecated.String
getFlowId()
Get 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。UserInfo
getOperator()
Get 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`void
setAgent(Agent Agent)
Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。void
setCcNotifyType(Long CcNotifyType)
Set 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型: **0** :合同发起时通知通知对方来查看合同(默认) **1** : 签署完成后通知对方来查看合同void
setClientToken(String ClientToken)
Deprecated.void
setFlowId(String FlowId)
Set 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。void
setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
-
-
-
-
Constructor Detail
-
StartFlowRequest
public StartFlowRequest()
-
StartFlowRequest
public StartFlowRequest(StartFlowRequest 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
-
getOperator
public UserInfo getOperator()
Get 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`- Returns:
- Operator 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
-
setOperator
public void setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`- Parameters:
Operator
- 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
-
getFlowId
public String getFlowId()
Get 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。- Returns:
- FlowId 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
-
setFlowId
public void setFlowId(String FlowId)
Set 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。- Parameters:
FlowId
- 合同流程ID,为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
-
getClientToken
@Deprecated public String getClientToken()
Deprecated.Get 客户端Token,保持接口幂等性,最大长度64个字符- Returns:
- ClientToken 客户端Token,保持接口幂等性,最大长度64个字符
-
setClientToken
@Deprecated public void setClientToken(String ClientToken)
Deprecated.Set 客户端Token,保持接口幂等性,最大长度64个字符- Parameters:
ClientToken
- 客户端Token,保持接口幂等性,最大长度64个字符
-
getAgent
public Agent getAgent()
Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。- Returns:
- Agent 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
-
setAgent
public void setAgent(Agent Agent)
Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。- Parameters:
Agent
- 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
-
getCcNotifyType
public Long getCcNotifyType()
Get 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
- Returns:
- CcNotifyType 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
-
setCcNotifyType
public void setCcNotifyType(Long CcNotifyType)
Set 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
- Parameters:
CcNotifyType
- 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:- **0** :合同发起时通知通知对方来查看合同(默认)
- **1** : 签署完成后通知对方来查看合同
-
-