メインコンテンツへ飛ぶ

クラス: Dock

クラス: Dock

macOS Dock 内のアプリを制御する

プロセス: メイン
このクラスは 'electron' モジュールからはエクスポートされません。 Electron API では、他のメソッドの戻り値としてのみ利用できます。

以下の例は、Dock でアイコンをバウンスさせる方法を示しています。

const { app } = require('electron')
app.dock.bounce()

インスタンスメソッド

dock.bounce([type]) macOS

  • type String (任意) - criticalinformational にできます。 省略値は、informational です。

戻り値 Integer - このリクエストを表すID。

critical が渡された場合、ドックのアイコンはアプリケーションがアクティブになるか、リクエストがキャンセルされるまでバウンスします。

informational が渡されると、ドックアイコンが 1 秒間バウンスします。 ただし、アプリケーションがアクティブになるかリクエストがキャンセルされるまで、そのリクエストはアクティブのままです。

注釈: このメソッドは、アプリがフォーカスされていないときにのみ使用できます。アプリがフォーカスされていると -1 を返します。

dock.cancelBounce(id) macOS

  • id Integer

id のバウンスをキャンセルします。

dock.downloadFinished(filePath) macOS

  • filePath String

filePath がダウンロードフォルダの中の場合、ダウンロードのスタックをバウンスさせます。

dock.setBadge(text) macOS

  • text String

ドックのバッジ領域に表示される文字列を設定します。

dock.getBadge() macOS

戻り値 String - ドックのバッジ文字列。

dock.hide() macOS

ドックのアイコンを非表示にする

dock.show() macOS

戻り値 Promise<void> - Dock のアイコンが表示されたときに実行されます。

dock.isVisible() macOS

Returns Boolean - Dock のアイコンが表示されているかどうか。

dock.setMenu(menu) macOS

アプリケーションの [Dock メニュー][dock-menu] を設定します。

dock.getMenu() macOS

戻り値 Menu | null - アプリケーションの [Dock メニュー][dock-menu]

dock.setIcon(image) macOS

このドックアイコンに関連付けられた image を設定します。