Editor.Ipc
Methods
Editor.Ipc.cancelRequest (sessionID)
sessionID
string - Session ID.
Cancel request sent to main or renderer process.
Editor.Ipc.option (opts)
opts
objectexcludeSelf
boolean - exclude send ipc message to main process when callingEditor.Ipc.sendToAll
.
Ipc option used in Editor.Ipc.sendToAll
.
Editor.Ipc.sendToAll (message[, ...args, option])
message
string - Ipc message....args
... - Whatever arguments the message needs.option
object - You can indicate the last argument as an IPC option byEditor.Ipc.option({...})
.
Send message
with ...args
to all opened window and to main process asynchronously.
Editor.Ipc.sendToMain (message[, ...args, callback, timeout])
message
string - Ipc message....args
... - Whatever arguments the message needs.callback
function - You can specify a callback function to receive IPC reply at the last or the 2nd last argument.timeout
number - You can specify a timeout for the callback at the last argument. If no timeout specified, it will be 5000ms.
Send message
with ...args
to main process asynchronously. It is possible to add a callback as the last or the 2nd last argument to receive replies from the IPC receiver.
Editor.Ipc.sendToMainSync (message[, ...args])
message
string - Ipc message....args
... - Whatever arguments the message needs.
Send message
with ...args
to main process synchronized and return a result which is responded from main process.
Editor.Ipc.sendToMainWin (message[, ...args])
message
string - Ipc message....args
... - Whatever arguments the message needs.Send
message
with...args
to the main window asynchronously.
Editor.Ipc.sendToPackage (pkgName, message[, ...args])
pkgName
string - Package name.message
string - Ipc message....args
... - Whatever arguments the message needs.
Send message
with ...args
to main process by package name and the short name of the message.
Editor.Ipc.sendToPanel (panelID, message[, ...args, callback, timeout])
panelID
string - Panel ID.message
string - Ipc message....args
... - Whatever arguments the message needs.callback
function - You can specify a callback function to receive IPC reply at the last or the 2nd last argument.timeout
number - You can specify a timeout for the callback at the last argument. If no timeout specified, it will be 5000ms.
Send message
with ...args
to panel defined in renderer process asynchronously. It is possible to add a callback as the last or the 2nd last argument to receive replies from the IPC receiver.
Editor.Ipc.sendToWins (message[, ...args, option])
message
string - Ipc message....args
... - Whatever arguments the message needs.option
object - You can indicate the last argument as an IPC option byEditor.Ipc.option({...})
.
Send message
with ...args
to all opened windows asynchronously. The renderer process can handle it by listening to the message through the Electron.ipcRenderer
module.