Skip to content

Commit 090adb9

Browse files
Rectified issues in comments for NotificationMessagePayload (#879)
* Rectified issues in comments for NotificationMessagePayload * Changed comments for sound in NotificationMessagePayload * Typo in comments * Adding articles for consistency Co-authored-by: Lahiru Maramba <[email protected]>
1 parent 03b6421 commit 090adb9

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

src/messaging.d.ts

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -632,6 +632,17 @@ export namespace admin.messaging {
632632
* for code samples and detailed documentation.
633633
*/
634634
interface NotificationMessagePayload {
635+
636+
/**
637+
* Identifier used to replace existing notifications in the notification drawer.
638+
*
639+
* If not specified, each request creates a new notification.
640+
*
641+
* If specified and a notification with the same tag is already being shown,
642+
* the new notification replaces the existing one in the notification drawer.
643+
*
644+
* **Platforms:** Android
645+
*/
635646
tag?: string;
636647

637648
/**
@@ -673,13 +684,11 @@ export namespace admin.messaging {
673684
color?: string;
674685

675686
/**
676-
* Identifier used to replace existing notifications in the notification drawer.
677-
*
678-
* If not specified, each request creates a new notification.
679-
*
680-
* If specified and a notification with the same tag is already being shown,
681-
* the new notification replaces the existing one in the notification drawer.
682-
*
687+
* The sound to be played when the device receives a notification. Supports
688+
* "default" for the default notification sound of the device or the filename of a
689+
* sound resource bundled in the app.
690+
* Sound files must reside in `/res/raw/`.
691+
*
683692
* **Platforms:** Android
684693
*/
685694
sound?: string;

0 commit comments

Comments
 (0)