unsubscribe · 显式取消宿主对某个事件的订阅。 - 鼠子Blog

显式取消宿主对某个事件的订阅。

签名

TypeScript

KSM.unsubscribe(event: string): Promise<void>

平台与权限

Windows	Android	权限
支持	支持	无

参数

参数	类型	必填	说明
`event`	`string`	是	已注册事件名

返回值

Promise<void>。宿主确认退订后完成。

行为

发送 event.unsubscribe 协议命令。
成功后从重建恢复集合中移除该事件。
重复退订是幂等的。
不会移除前端监听器；如需同时清理，应调用 on() 返回的清理函数。
系统事件 webview.reloaded 无需退订。

示例

TypeScript

await KSM.unsubscribe('window.resized');

错误

错误	场景
普通 `TypeError`	事件名未注册
普通 `Error`	桥接未初始化
`INVALID_ARGS`	宿主拒绝未注册事件
`TIMEOUT`	宿主未在默认时间内响应

相关