Plugin API
English
English
  • Getting Started
    • Introduction
    • Your First Plugin
    • File Structure Overview
    • Plugin Types
      • Window
      • Background Service
      • Format Extension
      • Inspector
    • Debug Plugin
  • Distribution
    • Prepare Plugin
    • Package Plugin
    • Publish Plugin
    • Update Plugin
    • Developer Policies
    • Plugin Icon Template
  • Developer Guide
    • manifest.json Configuration
    • Retrieve Data
    • Modify Data
    • Access Local Files
    • Issue Network Requests
    • Using Node.js Native API
    • Using Third-Party Modules
    • Multilingual (i18n)
    • Frameless Window
  • API Reference
    • event
    • item
    • folder
    • tag
    • tagGroup
    • library
    • window
    • app
    • os
    • screen
    • notification
    • contextMenu
    • dialog
    • clipboard
    • drag
    • shell
    • log
  • Extra Moudle
    • FFmpeg
Powered by GitBook
On this page
  • beep()
  • openExternal(url)
  • openPath(path)
  • showItemInFolder(path)
  1. API Reference

shell

Manage files and URLs using default applications.

The shell module provides functionalities related to desktop integration.


Methods

beep()

Plays the system's beep sound.

  • Returns Promise<void>

await eagle.shell.beep();

openExternal(url)

Opens the specified URL using the system's default method. Note: This function will not have any effect if there is no default application set by the system.

  • url string - The URL to be opened

  • Returns Promise<void>

await eagle.shell.openExternal('https://www.google.com/');

openPath(path)

Opens the specified path using the system's default method.

  • path string - The file path to be opened

  • Returns Promise<void>

await eagle.shell.openPath('path_to_file');

showItemInFolder(path)

Shows the specified file or folder in the file manager.

  • path string - The file or folder to be displayed

  • Returns Promise<void>

await eagle.shell.showItemInFolder('path_to_file_or_directory');

PreviousdragNextlog

Last updated 2 years ago