本文へスキップ

クラス: Dock

クラス: Dock​

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

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

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

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

インスタンスメソッド​

dock.bounce([type]) macOS​

  • type string (オプション) - criticalまたはinformationalを指定できます。デフォルトはinformationalです。

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

criticalが渡されると、アプリケーションがアクティブになるか、リクエストがキャンセルされるまで、Dockアイコンはバウンスし続けます。

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

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

dock.cancelBounce(id) macOS​

  • id Integer

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

dock.downloadFinished(filePath) macOS​

  • filePath string

filePathがダウンロードフォルダ内にある場合、ダウンロードスタックをバウンスします。

dock.setBadge(text) macOS​

  • text string

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

dock.getBadge() macOS​

戻り値 string - Dockのバッジ文字列。

dock.hide() macOS​

Dockアイコンを隠します。

dock.show() macOS​

戻り値 Promise<void> - Dockアイコンが表示されると解決されます。

dock.isVisible() macOS​

戻り値 boolean - Dockアイコンが表示されているかどうか。

dock.setMenu(menu) macOS​

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

dock.getMenu() macOS​

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

dock.setIcon(image) macOS​

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