Spec-Zone.ru › Electron

shell

Управление файлами и 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 строка — Максимальная длина 2081 символ на Windows.
  • options Объект (необязательно)
    • activate логическое значение (необязательно) macOS — true для вывода открытого приложения на передний план. По умолчанию true.
    • workingDirectory строка (необязательно) Windows — Рабочая папка.

Возвращает Promise<void>

Открывает указанный URL внешнего протокола стандартным способом на рабочем столе. (Например, mailto: URL-адреса в стандартном почтовом клиенте пользователя).

shell.trashItem(path)​

  • path строка — путь к элементу, который нужно переместить в корзину.

Возвращает Promise<void> — Разрешает, когда операция завершена. Отклоняет, если произошла ошибка при удалении запрошенного элемента.

Перемещает путь в расположение корзины ОС (Корзина на macOS, Корзина на Windows и расположение, специфичное для среды рабочего стола, на Linux).

shell.beep()​

Проигрывает звуковой сигнал.

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

  • shortcutPath строка
  • operation строка (необязательно) — По умолчанию create, может быть одним из следующих:
    • create — Создаёт новый ярлык, перезаписывая при необходимости.
    • update — Обновляет только указанные свойства существующего ярлыка.
    • replace — Перезаписывает существующий ярлык, отклоняется, если ярлык не существует.
  • options ShortcutDetails

Возвращает boolean — Успешно ли был создан ярлык.

Создаёт или обновляет ярлык по адресу shortcutPath.

shell.readShortcutLink(shortcutPath) Windows​

  • shortcutPath строка

Возвращает ShortcutDetails

Разрешает ярлык по адресу shortcutPath.

Исключение будет выброшено при возникновении любой ошибки.

© GitHub Inc.
Licensed under the MIT license.
https://www.electronjs.org/docs/latest/api/shell

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API