ipcMain API 列表
本模块包含 9 个 API。
Methods(方法)
| API | 说明 | 鸿蒙支持 |
|---|---|---|
| ipcMain.on(channel, listener) | 监听指定 channel,当收到新消息时以 listener(event, args...) 的形式调用监听函数。 | 支持 |
| ipcMain.off(channel, listener) | 从指定 channel 的监听数组中移除特定的 listener。 | 支持 |
| ipcMain.once(channel, listener) | 为事件添加一次性监听函数,在指定 channel 收到下一条消息后触发并自动移除。 | 支持 |
| ipcMain.addListener(channel, listener) | ipcMain.on 的别名。 | 支持 |
| ipcMain.removeListener(channel, listener) | ipcMain.off 的别名。 | 支持 |
| ipcMain.removeAllListeners([channel]) | 移除指定 channel 的所有监听器,若未指定 channel 则移除所有 channel 的监听器。 | 支持 |
| ipcMain.handle(channel, listener) | 为可调用的 IPC 添加处理函数,当渲染进程调用 ipcRenderer.invoke(channel, ...args) 时触发。 | 支持 |
| ipcMain.handleOnce(channel, listener) | 处理单次可调用 IPC 消息后自动移除监听器,参见 ipcMain.handle(channel, listener)。 | 支持 |
| ipcMain.removeHandler(channel) | 移除指定 channel 上的处理函数(如存在)。 | 支持 |