firebase-js-sdk/docs-devsite/messaging_sw.notificationpayload.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

NotificationPayload interface

Display notification details. Details are sent through the Send API.

Signature:

export interface NotificationPayload 

Properties

Property	Type	Description
body	string	The notification's body text.
icon	string	The URL to use for the notification's icon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest.
image	string	The URL of an image that is downloaded on the device and displayed in the notification.
title	string	The notification's title.

NotificationPayload.body

The notification's body text.

Signature:

body?: string;

NotificationPayload.icon

The URL to use for the notification's icon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest.

Signature:

icon?: string;

NotificationPayload.image

The URL of an image that is downloaded on the device and displayed in the notification.

Signature:

image?: string;

NotificationPayload.title

The notification's title.

Signature:

title?: string;