简体中文
callTool
约 426 字大约 1 分钟
2026-09-04
该方法用于调用操作中心。调用时传入工具路径 commandPath、业务参数 data 和可选的 options。方法会返回一个 Promise。
语法: FxUI.biz.callTool(commandPath, data, options)
参数
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| commandPath | 操作路径(必填) | Array | — | — |
| data | 传给工具的业务数据(必填) | Object | — | — |
| options | 附加选项 | Object | — | { raw: true } |
options
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| raw | 是否使用原始返回模式 | boolean | true、false | true |
示例
const commandPath = ['approval', 'runtime', 'my-approval-tasks'];
const data = {};
FxUI.biz.callTool(commandPath, data, { raw: true }).then((res) => {
if (res.success) {
console.log(res.data);
} else {
console.log(res.error);
}
});不传第三个参数时,会使用默认 options:
const commandPath = ['approval', 'runtime', 'my-approval-tasks'];
const data = {};
FxUI.biz.callTool(commandPath, data).then((res) => {
console.log(res);
});返回结果
返回一个 Promise,结果结构如下:
{
success: true,
data: {}
}调用失败时:
{
success: false,
error: {}
}操作库查询
所有可用的操作(commandPath 及其 data 字段结构)均在操作中心统一维护,可在以下地址查阅:
https://www.fxiaoke.com/XV/UI/manage#aigcactionmanagement
commandPath 与操作库的映射关系
操作中心中每条操作记录包含一个完整的 CLI 调用路径,格式为:
<binary> <sub1> <sub2> ... [--data '{…}'] [--raw]将其转换为 callTool 参数的规则:
- 去掉二进制名称(如
sharecrm) - 剩余的空格分隔部分按顺序组成
commandPath数组 --data '{…}'的内容对应data参数
示例:操作库中的 CLI 路径为
sharecrm data record query-by-fields --data '{"objectApiName":"Account__C"}' --raw对应的 callTool 调用为:
FxUI.biz.callTool(
['data', 'record', 'query-by-fields'],
{ objectApiName: 'Account__C' }
);注意事项
commandPath的具体取值和data的字段结构请以操作库中对应操作的说明为准。raw默认值为true,通常无需修改。
