跳转到主要内容

会话生命周期事件

会话生命周期事件是通知会话的创建、删除、更新以及前台 / 后台状态变化(TUI+服务器模式下)的事件。

事件类型

SessionLifecycleEventType enum 中定义了 5 个事件类型。

订阅事件

使用 onLifecycle() 方法可以订阅会话生命周期事件。

SessionLifecycleEvent

SessionLifecycleEvent 是包含生命周期事件详情的 readonly class。

SessionLifecycleEventMetadata

包含会话元数据的类(删除事件中不包含)。

前台会话管理

当连接到以 TUI+服务器模式(--ui-server)运行的服务器时,可以管理前台会话。

获取当前的前台会话

设置前台会话

ForegroundSessionInfo

包含前台会话信息的 readonly class。

在 TCP 模式下的使用

以 TUI+服务器模式启动 Copilot CLI,从 SDK 连接就可以利用生命周期事件。

注意事项

  • session.foregroundsession.background 事件仅在 TUI+服务器模式下发生
  • 会话被删除时(session.deletedmetadata 属性为 null
  • onLifecycle() 会返回用于取消订阅的回调函数
  • 这与 Session Hooks 中的 onSessionStartonSessionEnd 是不同的功能
最新信息请参考 GitHub 仓库
最后修改于 2026年7月18日