ToolEventCallback用于接收CLI工具进程运行期间产生的会话事件。
起始版本: 26.0.1
本模块接口仅可在Stage模型下使用。
type OnEventFn = (event: CliToolEvent) => void
CLI工具会话事件的回调函数类型。
起始版本: 26.0.1
系统能力:SystemCapability.Ability.AgentRuntime.Core
模型约束:此接口仅可在Stage模型下使用。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | CliToolEvent | 是 | CLI工具进程运行期间产生的会话事件。 |
CLI工具会话事件的回调接口。
起始版本: 26.0.1
系统能力:SystemCapability.Ability.AgentRuntime.Core
模型约束:此接口仅可在Stage模型下使用。
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| onEvent | OnEventFn | 否 | 否 | CLI工具会话事件回调函数。 |
示例:
import { common } from '@kit.AbilityKit';
// 定义CLI工具会话事件的回调对象
let callback: common.ToolEventCallback = {
onEvent: (event: common.CliToolEvent) => {
console.info('tool event type: ' + event.toolEventType + ', data: ' + event.data);
}
};