Applications
13 in apps0 in games
Interact with and track external applications running on the host system.
This module must be enabled under "Plugins" in the Deskifier Dashboard
Methods
Bring External Application To Top Apps only
Brings an external application to the top and sets it as the focus.
await window.deskifier.applications.bringToTop({ arguments })
Arguments
idNumber (Required)
The ID of the application
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Restore External Application Apps only
Restores an external application from a hidden state.
await window.deskifier.applications.restore({ arguments })
Arguments
idNumber (Required)
The ID of the application
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Minimize External Application Apps only
Hides an external application's window.
await window.deskifier.applications.minimize({ arguments })
Arguments
idNumber (Required)
The ID of the application
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Maximize External Application Apps only
Maximizes an external application.
await window.deskifier.applications.maximize({ arguments })
Arguments
idNumber (Required)
The ID of the application
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Set External Application Bounds Apps only
Requires accessibility permission on macOS
Sets the position and size of an external application's window.
await window.deskifier.applications.setBounds({ arguments })
Arguments
idNumber (Required)
The ID of the applicationxNumber (Optional)
The X offset.yNumber (Optional)
The Y offset.widthNumber (Optional)
The width of the external application.heightNumber (Optional)
The height of the external application.
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Overlay Apps only
Starts an overlay window that follows an external application or the active focus.
await window.deskifier.applications.overlay({ arguments })
Arguments
applicationIdNumber (Optional)
The ID of the application to overlay. If omitted, the overlay follows focus.windowIdString (Optional)
A specific window ID to target.refreshIntervalNumber (Optional)
How often (in ms) the overlay position refreshes while the target is active.idleRefreshIntervalNumber (Optional)
How often (in ms) the overlay position refreshes while the target is idle.
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.windowIdString
The ID of the overlay window.applicationIdNumber
The ID of the application being overlaid, ornullif following focus.followsFocusBoolean
Whether the overlay follows the active focus.refreshIntervalNumberidleRefreshIntervalNumber
Stop Overlay Apps only
Stops an active overlay window.
await window.deskifier.applications.stopOverlay({ arguments })
Arguments
windowIdString (Optional)
The ID of the overlay window to stop. If omitted, stops the current overlay.
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.
Properties
Get Active Application Apps only
Returns the current active (focused) application details.
await window.deskifier.applications.getActive()
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.applicationDetailsDeskifier.applicationDetails
Get Applications Apps only
Returns applications currently running on the device.
await window.deskifier.applications.getAll()
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.applicationDetailsArray Of Deskifier.applicationDetails
Get Tracked Overlays Apps only
Returns all currently active overlay windows.
await window.deskifier.applications.getTrackedOverlays()
Returns
successBoolean
If the action was successful.messageString
Additional confirmation, or error details if action was unsuccessful.overlaysArray of overlay objects.
Events
External Application Activated Apps only
Fires when a user switches applications.
window.deskifier.applications.onExternalActivated((data) => { })
Arguments
activeApplicationDeskifier.applicationDetails
Overlay Started Apps only
Fires when an overlay window starts tracking an application.
window.deskifier.applications.onOverlayStarted((data) => { })
Arguments
windowIdStringapplicationIdNumber —nullif following focus.followsFocusBooleanrefreshIntervalNumberidleRefreshIntervalNumber
Overlay Stopped Apps only
Fires when an overlay window stops tracking.
window.deskifier.applications.onOverlayStopped((data) => { })
Arguments
windowIdStringreasonString
Why the overlay stopped. One of:manual,replaced,window-destroyed,target-gone.
Objects
applicationDetails Apps only
idNumber
The ID of the application.titleString
The application title.processIdNumberpathString
The application executable path.boundsObject (Optional)widthNumber
The application's window width.heightNumber
The application's window height.xNumber
The application's window X offset.yNumber
The application's window Y offset.
isVisibleBoolean (Optional)
If the application is currently visible (Note, this isn't always fully accurate).isWindowBoolean (Optional)
If the application has an interactive window (Note, this isn't always fully accurate).zOrderNumber (Optional)
The application's Z-order position in the window stack.iconString (Optional)
Base64-encoded icon image for the application, ornullif unavailable.