Saltar al contenido principal

Clase: Dock

Clase: Dock​

Controla tu aplicación en el dock de macOS

Process: Main
This class is not exported from the 'electron' module. Sólo está disponible como un valor de retorno de otros métodos en la API de Electron.

[!TIP] Consulte además: Una guía detallada acerca de como implementar menús de Muelle.

Métodos de Instancia​

dock.bounce([type]) macOS​

  • type string (opcional) - Puede ser critical o informational. Por defecto es informational

Devuelve Integer - un ID que representa la solicitud.

Cuando critical es pasado, el ícono del punto rebotará hasta que la aplicación se vuelva activa o la petición sea cancelada.

Cuando informational es pasado, el icono del dock rebotará por un segundo. Sin embargo, la solicitud permanece activa hasta que la aplicación se vuelta activa o la solicitud sea cancelada.

[!NOTA] Este método solo se puede usar mientras la aplicación no está focalizada; cuando la aplicación está enfocada devolverá -1.

dock.cancelBounce(id) macOS​

  • id Íntegro

Cancela el rebote de id.

dock.downloadFinished(filePath) macOS​

  • filePath string

Rebota la apilación de descargas si el archivo de camino está dentro de la carpeta de descargas.

dock.setBadge(text) macOS​

  • texto cadena

Establece la cadena para ser mostrada en el área de insignia del punto.

[!IMPORTANT] Necesita asegurarse que su aplicación tiene el permiso para exhibir notificaciones para que este método funcione.

dock.getBadge() macOS​

Devuelve string - La insignia cadena del punto.

dock.hide() macOS​

Esconde el icono del punto.

dock.show() macOS​

Devuelve Promise<void> - Se resuelve cuando se muestra el icono del dock.

dock.isVisible() macOS​

Devuelve boolean - Si el icono del dock es visible.

dock.setMenu(menu) macOS​

Establece el menú acoplado de la aplicación.

dock.getMenu() macOS​

Devuelve Menu | null - El menú de acoplamiento de la aplicación.

dock.setIcon(image) macOS​

Establece la image asociada con el ícono del punto.