AboutSupportDeveloper GuideVersion 46.156.100.97
OpenFin JavaScript API
    Preparing search index...

    Interface DockIconClickedEvent

    Generated on macOS when the user clicks this runtime's dock icon, or opens the app again from Finder, while the runtime is running. Only raised to listeners in this runtime, not to other connected runtimes.

    macOS only. On Windows and Linux, launching an application that is already running raises run-requested on that application instead.

    By default, the platform provider handles this event in PlatformProvider.handleDockIconClicked, which reopens the platform when it has no windows. The default reopen requires platform.allowLaunchIntoPlatform: true.

    interface DockIconClickedEvent {
        hasVisibleWindows: boolean;
        topic: "system";
        type: "dock-icon-clicked";
        uuid?: string;
    }
    Index
    hasVisibleWindows: boolean

    Whether macOS found any visible windows in this runtime. Hidden windows do not count.

    topic: "system"

    The "kebab-case" classname of the emitter that raised the event.

    OpenFin.Frame is represented as iframe.

    type: "dock-icon-clicked"

    The type of event that was raised. Equal to the typename of the event payload in "kebab case".

    Guaranteed to be unique within each topic, but can be repeated between topics (e.g. WebContentsEvents.CrashedEvent and ApplicationEvents.CrashedEvent).

    uuid?: string

    UUID of the application the runtime was started with, if any.