シェル

デフォルトアプリケーションを使用してファイルとURLを管理します。

プロセス: メイン、レンダラー (サンドボックス化されていない場合のみ)

shell モジュールは、デスクトップ統合に関連する機能を提供します。

ユーザーのデフォルトブラウザでURLを開く例

const { shell } = require('electron')

shell.openExternal('https://github.com')

注: shell モジュールはレンダラープロセスで使用できますが、サンドボックス化されたレンダラーでは機能しません。

メソッド

shell モジュールには、次のメソッドがあります。

shell.showItemInFolder(fullPath)

• fullPath 文字列

指定されたファイルをファイルマネージャに表示します。 可能であれば、ファイルを選択します。

shell.openPath(path)

• path 文字列

戻り値 Promise<string> - 失敗が発生した場合、失敗に対応するエラーメッセージを含む文字列で解決されます。そうでない場合は "" です。

指定されたファイルをデスクトップのデフォルトの方法で開きます。

shell.openExternal(url[, options])

• url 文字列 - Windowsでは最大2081文字。
• options オブジェクト (オプション)
  • activate 真偽値 (オプション) macOS - 開いたアプリケーションをフォアグラウンドにする場合はtrue。 デフォルトはtrueです。
  • workingDirectory 文字列 (オプション) Windows - 作業ディレクトリ。
  • logUsage 真偽値 (オプション) Windows - 頻繁に使用されるプログラムやその他の動作の追跡を可能にする、ユーザーが開始した起動を示します。 デフォルトはfalseです。

戻り値 Promise<void>

指定された外部プロトコルURLをデスクトップのデフォルトの方法で開きます。 (たとえば、ユーザーのデフォルトメールエージェントのmailto: URL)。

shell.trashItem(path)

• path 文字列 - ゴミ箱に移動するアイテムのパス。

戻り値 Promise<void> - 操作が完了したら解決されます。 要求されたアイテムの削除中にエラーが発生した場合は拒否されます。

これは、パスをOS固有のゴミ箱の場所に移動します（macOSではゴミ箱、Windowsではごみ箱、Linuxではデスクトップ環境固有の場所）。

shell.beep()

ビープ音を鳴らします。

shell.writeShortcutLink(shortcutPath[, operation], options) Windows

• shortcutPath 文字列
• operation 文字列 (オプション) - デフォルトはcreateで、次のいずれかになります。
  • create - 新しいショートカットを作成し、必要に応じて上書きします。
  • update - 既存のショートカットの指定されたプロパティのみを更新します。
  • replace - 既存のショートカットを上書きします。ショートカットが存在しない場合は失敗します。
• options ショートカットの詳細

戻り値 boolean - ショートカットが正常に作成されたかどうか。

shortcutPath にショートカットリンクを作成または更新します。

shell.readShortcutLink(shortcutPath) Windows

• shortcutPath 文字列

戻り値 ショートカットの詳細

shortcutPath のショートカットリンクを解決します。

エラーが発生すると例外がスローされます。