events
Functions
emitRemoveWidgetsToCanvas()
emitRemoveWidgetsToCanvas(
payload):Promise<void>
Emit the "remove-widgets" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | RemoveWidgetsPayload | The payload of the event. |
Returns
Promise<void>
Defined in
emitRenderWidgetToCanvas()
emitRenderWidgetToCanvas(
payload):Promise<void>
Emit the "render-widget" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | RenderWidgetPayload | The payload of the event. |
Returns
Promise<void>
Defined in
emitSwitchThemeAppearanceToCanvas()
emitSwitchThemeAppearanceToCanvas(
payload):Promise<void>
Emit the "switch-theme-appearance" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | ThemeAppearance | The payload of the event. |
Returns
Promise<void>
Defined in
emitUpdateSettingToManager()
emitUpdateSettingToManager(
payload):Promise<void>
Emit the "update-setting" event to the manager window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | UpdateSettingPayload | The payload of the event. |
Returns
Promise<void>
Defined in
listenToExitApp()
listenToExitApp(
handler):Promise<UnlistenFn>
Listen to the "exit-app" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<null> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
Defined in
listenToRemoveWidgets()
listenToRemoveWidgets(
handler):Promise<UnlistenFn>
Listen to the "remove-widgets" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<RemoveWidgetsPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
Defined in
listenToRenderWidget()
listenToRenderWidget(
handler):Promise<UnlistenFn>
Listen to the "render-widget" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<RenderWidgetPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
Defined in
listenToShowToast()
listenToShowToast(
handler):Promise<UnlistenFn>
Listen to the "show-toast" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<ShowToastPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
Defined in
listenToSwitchThemeAppearance()
listenToSwitchThemeAppearance(
handler):Promise<UnlistenFn>
Listen to the "switch-theme-appearance" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<ThemeAppearance> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
Defined in
listenToUpdateSetting()
listenToUpdateSetting(
handler):Promise<UnlistenFn>
Listen to the "update-setting" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<UpdateSettingPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.