Skip to main content

Namespace: Desktop

main.common.Desktop

References

autoArrange

Re-exports autoArrange


bringAllWindowsToFront

Renames and re-exports bringWindowsToFront


minimizeAll

Re-exports minimizeAll

Functions

bringWindowsToFront

bringWindowsToFront(params?, cb?): Promise<void>

Brings a windows to front. If no windowList, groupName or componentType is specified, brings all windows to front.

FSBL.Clients.LauncherClient.bringWindowsToFront({ windowList: ['AdvancedChart-123-123', 'Symphony-Chat-234-234']}, function(err, response) {
// do something
})

Parameters

NameTypeDefault valueDescription
paramsObject{}
params.componentType?stringundefinedOptional. The componentType to bring to front. Not to be used with windowList.
params.groupName?stringundefinedOptional. The name of a window group to bring to front.
params.windowList?string[] | WindowIdentifier[]undefinedOptional. An array An array of window names or window identifiers. Not to be used with componentType.
cbFunctionFunction.prototype-

Returns

Promise<void>


minimizeWindows

minimizeWindows(params, cb?): Promise<void>

Minimize windows. If no windowList or groupName is specified, all windows will be minimized.

Parameters

NameTypeDescription
paramsObject
params.componentType?stringOptional. The component type of windows to Minimize. Not to be used with windowList.
params.groupName?stringOptional. The name of a window group to minimize.
params.windowList?string[] | WindowIdentifier[]Optional. An array of window names or window identifiers. Not to be used with componentType.
cb?Function-

Returns

Promise<void>


restartApplication

restartApplication(params?): void

Restart the SmartDesktop (Finsemble).

Parameters

NameType
params?RestartParams

Returns

void


shutdownApplication

shutdownApplication(): void

Shutdown the SmartDesktop (Finsemble).

Returns

void