メインコンテンツへ飛ぶ

クラス: Dock

クラス: Dock​

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

Process: Main
This class is not exported from the 'electron' module. Electron API では、他のメソッドの戻り値としてのみ利用できます。

[!TIP] See also: A detailed guide about how to implement Dock menus.

インスタンスメソッド​

dock.bounce([type]) macOS​

  • type string (任意) - critical か informational にできます。 省略値は、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

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

[!IMPORTANT] You need to ensure that your application has the permission to display notifications for this method to work.

dock.getBadge() macOS​

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

dock.hide() macOS​

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

dock.show() macOS​

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

dock.isVisible() macOS​

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

dock.setMenu(menu) macOS​

Sets the application's dock menu.

dock.getMenu() macOS​

Returns Menu | null - The application's dock menu.

dock.setIcon(image) macOS​

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