ipcRenderer API 列表
本模块包含 11 个 API。
Methods(方法)
| API | 说明 | 鸿蒙支持 |
|---|---|---|
| ipcRenderer.on(channel, listener) | 监听指定 channel,当收到新消息时以 listener(event, args...) 的形式调用监听函数。 | 支持 |
| ipcRenderer.off(channel, listener) | 从指定 channel 的监听数组中移除特定的 listener。 | 支持 |
| ipcRenderer.once(channel, listener) | 为事件添加一次性监听函数,在指定 channel 收到下一条消息后触发并自动移除。 | 支持 |
| ipcRenderer.addListener(channel, listener) | ipcRenderer.on 的别名。 | 支持 |
| ipcRenderer.removeListener(channel, listener) | ipcRenderer.off 的别名。 | 支持 |
| ipcRenderer.removeAllListeners([channel]) | 移除指定 channel 的所有监听器,若未指定 channel 则移除所有 channel 的监听器。 | 支持 |
| ipcRenderer.send(channel, ...args) | 通过 channel 向主进程发送异步消息,参数使用结构化克隆算法序列化,原型链不会被包含。 | 支持 |
| ipcRenderer.invoke(channel, ...args) | 返回 Promise,以主进程的响应结果 resolve。 | 支持 |
| ipcRenderer.sendSync(channel, ...args) | 返回 any,即 ipcMain 处理函数返回的值。 | 支持 |
| ipcRenderer.postMessage(channel, message, [transfer]) | 向主进程发送消息,可选择性地转移一个或多个 MessagePort 对象的所有权。 | 支持 |
| ipcRenderer.sendToHost(channel, ...args) | 与 ipcRenderer.send 类似,但消息将发送到宿主页面中的 元素,而非主进程。 | 支持 |