クラス: Dock

クラス: Dock

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

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

ヒント

ドックメニューを実装するための詳細なガイド を参照。

インスタンスメソッド

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] このメソッドが機能するために、アプリケーションに通知を表示する権限があることを確かめてください。

dock.getBadge() macOS

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

dock.hide() macOS

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

dock.show() macOS

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

dock.isVisible() macOS

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

dock.setMenu(menu) macOS

• menu Menu

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

dock.getMenu() macOS

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

dock.setIcon(image) macOS

• image (NativeImage | string)

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