AboutSupportDeveloper GuideVersion 1.2.1

Interface ServerOptions

Options for starting the Snap Server

interface ServerOptions {
    autoHideClientTaskbarIcons?: boolean;
    blurEffectPerformanceThreshold?: number;
    disableBlurDropPreview?: boolean;
    disableGPUAcceleratedDragging?: boolean;
    disableRuntimeHeartbeating?: boolean;
    disableUserUnstick?: boolean;
    executablePath?: string;
    hideTaskbarEntry?: boolean;
    keyToStick?: boolean;
    showDebug?: boolean;
    taskbarIcon?: string;
    taskbarIconGroup?: string;
}

Properties

autoHideClientTaskbarIcons? blurEffectPerformanceThreshold? disableBlurDropPreview? disableGPUAcceleratedDragging? disableRuntimeHeartbeating? disableUserUnstick? executablePath? hideTaskbarEntry? keyToStick? showDebug? taskbarIcon? taskbarIconGroup?

Properties

OptionalautoHideClientTaskbarIcons

autoHideClientTaskbarIcons?: boolean

If true, Snap will try to hide the taskbar icons of windows that are snapped together, and re-show the icons when windows are unsnapped.

OptionalblurEffectPerformanceThreshold

blurEffectPerformanceThreshold?: number

This is respected only if the disableBlurDropPreview option is not set. This threshold (in milliseconds) relates to the time taken to render a blur effect. Snap will do a check at start up to measure this performance and automatically disable the blur effect if this threshold time is exceeded. If not provided, the performance check will use a default threshold.

OptionaldisableBlurDropPreview

disableBlurDropPreview?: boolean

If true, the drop preview will not be blurred. This can be useful if performance issues are encountered when displaying a drop target and preview. This can occur on lower spec machines.

OptionaldisableGPUAcceleratedDragging

disableGPUAcceleratedDragging?: boolean

If true, reverts to a slower method of dragging groups of windows

OptionaldisableRuntimeHeartbeating

disableRuntimeHeartbeating?: boolean

If true, the Snap server will not send runtime heartbeats to the OpenFin runtime. Ordinarily heartbeating is useful to ensure that the runtime cleans up resources quickly after a client disconnects.

OptionaldisableUserUnstick

disableUserUnstick?: boolean

If true, prevents the user from unsticking windows (e.g. using SHIFT key)

OptionalexecutablePath

executablePath?: string

The path to the Snap executable to launch if not using a manifest asset

OptionalhideTaskbarEntry

hideTaskbarEntry?: boolean

If true, snapped window groups will not be shown in the taskbar.

OptionalkeyToStick

keyToStick?: boolean

If true, windows will only stick if CTRL key is held while dragging

OptionalshowDebug

showDebug?: boolean

True if the Snap debug console should be shown

OptionaltaskbarIcon

taskbarIcon?: string

If set, this specifies a URL for a .ico file that will be used in the taskbar for the snapped window groups.

OptionaltaskbarIconGroup

taskbarIconGroup?: string

An ID used by Windows for grouping taskbar entries. If set, all snapped window groups will be shown under the same taskbar entry. If you want to show the snapped window groups under the same taskbar entry as your OpenFin application, you must set this value carefully, as follows: it must start with a prefix of openfin_apps_group. and follow with the value of the following field in the app: https://developer.openfin.co/docs/javascript/stable/interfaces/OpenFin.ApplicationCreationOptions.html#taskbarIconGroup

Settings

Member Visibility

On This Page

Properties