IPC Channel Reference
Framework channels handled by registerNextOP. (You normally use the hooks, not these directly.)
User channels should use the app: prefix.
| Channel | Kind | Used by | Payload → Result |
|---|---|---|---|
fs:readFile | invoke | useFs.readFile | (filePath) → string |
fs:writeFile | invoke | useFs.writeFile | (filePath, content) → true |
window:minimize | invoke | useWindow.minimize | — |
window:maximize | invoke | useWindow.maximize | toggles maximize |
window:close | invoke | useWindow.close | — |
window:isMaximized | invoke | useWindow.isMaximized | → boolean |
set-menu | send | useMenu.setMenu | (template) |
open-external | send | Link / window.nextop.openExternal | (url) |
show-notification | send | useNotification | ({ title, body }) |
shell-execute | invoke | useShell.execute | ({ command, args }) → ShellResult |
read-clipboard | invoke | useClipboard.readText | (type?) → string |
write-clipboard | send | useClipboard.writeText | ({ text, type }) |
secure-store:isAvailable | invoke | useSecureStore.isAvailable | → boolean |
secure-store:set | invoke | useSecureStore.setItem | (key, value) → true |
secure-store:get | invoke | useSecureStore.getItem | (key) → string | null |
secure-store:remove | invoke | useSecureStore.removeItem | (key) → true |
secure-store:has | invoke | useSecureStore.hasItem | (key) → boolean |
secure-store:clear | invoke | useSecureStore.clear | → true |
open-internal-window | send | Link target="_blank" | (url, options?) |
dialog:showOpenDialog | invoke | useDialog.showOpenDialog | (options?) → string[] | null |
dialog:showSaveDialog | invoke | useDialog.showSaveDialog | (options?) → string | null |
tray:create | invoke | useTray | ({ tooltip?, menuTemplate?, icon? }) → true |
tray:destroy | send | useTray (unmount) | — |
tray:setToolTip | send | useTray.setToolTip | (tooltip) |
tray:setMenu | send | useTray.setMenu | (menuTemplate) |
tray:click | on (main → renderer) | useTray.onClick | — |
global-shortcut:register | invoke | useGlobalShortcut | (accelerator) → boolean |
global-shortcut:unregister | send | useGlobalShortcut (unmount) | (accelerator) |
global-shortcut:triggered | on (main → renderer) | useGlobalShortcut | (accelerator) |
store:get | invoke | useStore.getItem | (key) → T | null |
store:set | invoke | useStore.setItem | (key, value) → true |
store:remove | invoke | useStore.removeItem | (key) → true |
store:has | invoke | useStore.hasItem | (key) → boolean |
store:clear | invoke | useStore.clear | → true |