Dock

类：Dock¶

在 macOS 程序坞中控制你的应用

进程：主进程
该类未从 'electron' 模块导出。它仅可作为 Electron API 中其他方法的返回值使用。

[!TIP] 另请参阅：关于如何实现程序坞菜单的详细指南。

实例方法¶

dock.bounce([type]) macOS¶

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

返回 Integer - 一个表示该请求的 ID。

当传入 critical 时，程序坞图标将持续弹跳，直到应用变为活动状态或请求被取消。

当传入 informational 时，程序坞图标会弹跳一秒。 但是，该请求会保持活动状态，直到应用变为活动状态或请求被取消。

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

dock.cancelBounce(id) macOS¶

• id Integer

取消 id 的弹跳。

dock.downloadFinished(filePath) macOS¶

• filePath string

如果 filePath 位于下载文件夹内，则弹跳下载堆栈。

dock.setBadge(text) macOS¶

• text string

设置要在程序坞徽章区域显示的字符串。

[!IMPORTANT] 你需要确保你的应用具有显示通知的权限，此方法才能正常工作。

dock.getBadge() macOS¶

返回 string - 程序坞的徽章字符串。

dock.hide() macOS¶

隐藏程序坞图标。

[!IMPORTANT] 已知问题： 在距离上一次调用不到一秒内调用 dock.hide() 将不会生效。作为解决方法，请确保两次调用之间至少间隔一秒——例如，在上一次调用后使用 1100ms 或更长时间的 setTimeout 进行延迟。

dock.show() macOS¶

返回 Promise<void> - 当程序坞图标显示时解析。

dock.isVisible() macOS¶

返回 boolean - 程序坞图标是否可见。

dock.setMenu(menu) macOS¶

• menu Menu

设置应用的 程序坞菜单。

dock.getMenu() macOS¶

返回 Menu | null - 应用的 程序坞菜单。

dock.setIcon(image) macOS¶

• image (NativeImage | string)

设置与此程序坞图标关联的 image。