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
  • Methods
  • show(options)
  1. API Reference

notification

Display a pop-up window in the corner of the screen to inform users about operation status.

Methods

show(options)

Display a notification window

  • options Object

    • title string - Notification window title

    • description string - Notification window description

    • icon URL/base64 - Notification window icon, supporting URL or base64 format (optional)

    • mute boolean - Sound effect (optional)

    • duration Integer - Auto-hide duration (milliseconds) (optional)

  • Returns Promise<>

await eagle.notification.show({
    title: "Basic Notification",
    body: "Notification from the Plugin process",
    mute: false,
    duration: 3000,
    icon: "https://"
});

PreviousscreenNextcontextMenu

Last updated 2 years ago