Skip to content

Rectified issues in comments for NotificationMessagePayload #879

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
May 12, 2020
Merged

Rectified issues in comments for NotificationMessagePayload #879

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2db6a9d
Rectified issues in comments for NotificationMessagePayload
VPanjeta May 7, 2020
3c5f556
Changed comments for sound in NotificationMessagePayload
VPanjeta May 11, 2020
a7c418e
Typo in comments
VPanjeta May 11, 2020
2f7de97
Adding articles for consistency
VPanjeta May 11, 2020
36a1f67
Merge branch 'master' into master
lahirumaramba May 11, 2020
40ff74c
Merge branch 'master' into master
lahirumaramba May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions src/messaging.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,17 @@ export namespace admin.messaging {
* for code samples and detailed documentation.
*/
interface NotificationMessagePayload {

/**
* Identifier used to replace existing notifications in the notification drawer.
*
* If not specified, each request creates a new notification.
*
* If specified and a notification with the same tag is already being shown,
* the new notification replaces the existing one in the notification drawer.
*
* **Platforms:** Android
*/
tag?: string;

/**
Expand Down Expand Up @@ -673,14 +684,8 @@ export namespace admin.messaging {
color?: string;

/**
* Identifier used to replace existing notifications in the notification drawer.
*
* If not specified, each request creates a new notification.
*
* If specified and a notification with the same tag is already being shown,
* the new notification replaces the existing one in the notification drawer.
*
* **Platforms:** Android
* The sound to be played when the device receives the
* notification.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

/**
     * The sound to play when the device receives the notification. Supports
     * "default" or the filename of a sound resource bundled in the app. Sound files
     * must reside in `/res/raw/`.
     * 
     * **Platforms:** Android
     */

I think the docs from #820 might be more suitable here. I will leave @egilmorez to confirm.

*/
sound?: string;

Expand Down