Skip to content

Commit 9016954

Browse files
authored
Fixing Android notification options descriptions (#820)
* Fixing doc bug that conflated sound and tag options for Android notifications. * Removing duplicate documentation for tag. * Adding tag details in the right place this time, hopefully.
1 parent 7b9945f commit 9016954

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/index.d.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4659,7 +4659,6 @@ declare namespace admin.messaging {
46594659
* for code samples and detailed documentation.
46604660
*/
46614661
interface NotificationMessagePayload {
4662-
tag?: string;
46634662

46644663
/**
46654664
* The notification's body text.
@@ -4699,6 +4698,15 @@ declare namespace admin.messaging {
46994698
*/
47004699
color?: string;
47014700

4701+
/**
4702+
* The sound to play when the device receives the notification. Supports
4703+
* "default" or the filename of a sound resource bundled in the app. Sound files
4704+
* must reside in `/res/raw/`.
4705+
*
4706+
* **Platforms:** Android
4707+
*/
4708+
sound?: string;
4709+
47024710
/**
47034711
* Identifier used to replace existing notifications in the notification drawer.
47044712
*
@@ -4708,8 +4716,8 @@ declare namespace admin.messaging {
47084716
* the new notification replaces the existing one in the notification drawer.
47094717
*
47104718
* **Platforms:** Android
4711-
*/
4712-
sound?: string;
4719+
*/
4720+
tag?: string;
47134721

47144722
/**
47154723
* The notification's title.

0 commit comments

Comments
 (0)