类: Dock

类: Dock

在 macOS dock中控制您的应用

Process: Main
This class is not exported from the 'electron' module. 它只能作为 Electron API 中其他方法的返回值。

[!TIP] 另请参阅: 一个详细的关于如何实现Dock栏的教程。

实例方法

dock.bounce([type]) macOS

• type string (可选) - 可以是 critical 或 informational。 默认值为 informational

返回 Integer - 代表请求的 ID。

当传入的是 critical 时, dock 中的应用将会开始弹跳, 直到这个应用被激活或者这个请求被取消。

当传递了 informational 时，dock图标将弹跳一秒钟。 然而，该请求仍然有效，直到应用程序激活或请求被取消。

[!NOTE] 此方法只能在应用未获得焦点时使用；当应用已经获得焦点，此方法将返回 -1。

dock.cancelBounce(id) macOS

• id Integer

取消这个 id 对应的请求。

dock.downloadFinished(filePath) macOS

• filePath string

如果 filePath 位于 Downloads 文件夹中，则弹出下载队列。

dock.setBadge(text) macOS

• text string

设置应用在 dock 中显示的字符串。

[!IMPORTANT] 为了使该方法工作，您需要确保您的应用程序拥有通知权限。

dock.getBadge() macOS

返回 string - 应用在 dock 中显示的字符串。

dock.hide() macOS

隐藏 dock 中的图标。

dock.show() macOS

返回 Promise<void> - 当 dock 图标显示时 resolve。

dock.isVisible() macOS

返回 boolean - dock 图标是否可见。

dock.setMenu(menu) macOS

• menu 菜单

。

dock.getMenu() macOS

返回 Menu | null - 应用程序的 停靠菜单

dock.setIcon(image) macOS

• image (NativeImage | string)

设置 image 作为应用在 dock 中显示的图标。