Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add new options to tray.displayBalloon() #19544

Merged
merged 1 commit into from Aug 8, 2019

Conversation

miniak
Copy link
Contributor

@miniak miniak commented Jul 31, 2019

Description of Change

Adds new options to tray.displayBalloon():

--- a/electron.old.d.ts
+++ b/electron.new.d.ts
@@ -10846,9 +10846,30 @@ See webContents.sendInputEvent for detailed description of `event` object.
   }
 
   interface DisplayBalloonOptions {
+    /**
+     * Icon to use when `iconType` is `custom`.
+     */
     icon?: (NativeImage) | (string);
+    /**
+     * Can be `none`, `info`, `warning`, `error` or `custom`. Default is `custom`.
+     */
+    iconType?: ('none' | 'info' | 'warning' | 'error' | 'custom');
     title: string;
     content: string;
+    /**
+     * The large version of the icon should be used. Default is `true`. Maps to
+     * `NIIF_LARGE_ICON`.
+     */
+    largeIcon?: boolean;
+    /**
+     * Do not play the associated sound. Default is `false`. Maps to `NIIF_NOSOUND`.
+     */
+    noSound?: boolean;
+    /**
+     * Do not display the balloon notification if the current user is in "quiet time".
+     * Default is `false`. Maps to `NIIF_RESPECT_QUIET_TIME`.
+     */
+    respectQuietTime?: boolean;
   }

Checklist

Release Notes

Notes: New options added to tray.displayBalloon(): iconType, largeIcon, noSound and respectQuietTime.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Jul 31, 2019
@miniak miniak requested a review from codebytere July 31, 2019 15:21
@miniak miniak self-assigned this Jul 31, 2019
@miniak miniak force-pushed the miniak/tray-display-balloon-options branch 3 times, most recently from ab59997 to a58c94b Compare July 31, 2019 15:47
@miniak miniak marked this pull request as ready for review July 31, 2019 16:10
@miniak miniak force-pushed the miniak/tray-display-balloon-options branch from a58c94b to bdf5765 Compare July 31, 2019 16:12
@miniak miniak requested a review from deermichel July 31, 2019 16:13
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 1, 2019
@miniak miniak force-pushed the miniak/tray-display-balloon-options branch 3 times, most recently from 1891007 to 6a459dc Compare August 6, 2019 16:05
@miniak miniak force-pushed the miniak/tray-display-balloon-options branch from 6a459dc to 317c0e4 Compare August 6, 2019 17:36
@codebytere codebytere merged commit 0fb3c8c into master Aug 8, 2019
@release-clerk
Copy link

release-clerk bot commented Aug 8, 2019

Release Notes Persisted

New options added to tray.displayBalloon(): iconType, largeIcon, noSound and respectQuietTime.

@codebytere codebytere deleted the miniak/tray-display-balloon-options branch August 8, 2019 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants