invoke Method
Send a message to the backend via channel and expect a result asynchronously.
invoke(channel: string, ...args: any[]): Promise<any>
see Electron ipcRenderer.invoke documentation for details. Note that this interface may be implemented via Electron for desktop apps, or via WebSockets for mobile or web-based Ipc connections. In either case, the Electron documentation provides the specifications for how it works.
note args are serialized with the Structured Clone Algorithm, so only
primitive types and ArrayBuffers are allowed.
| Parameter | Type | Description |
|---|---|---|
| channel | string | The name of the channel for the method. Must begin with the iTwinChannel prefix. |
| ...args | any[] |
Returns - Promise<any>
Defined in
- core/common/src/ipc/IpcSocket.ts Line 80
Last Updated: 30 November, 2023