Back to Firebase Js Sdk

NotificationPayload interface

docs-devsite/messaging_sw.notificationpayload.md

12.12.11.9 KB
Original Source

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<!-- -->.

<b>Signature:</b>

typescript
export interface NotificationPayload 

Properties

PropertyTypeDescription
bodystringThe notification's body text.
iconstringThe 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.
imagestringThe URL of an image that is downloaded on the device and displayed in the notification.
titlestringThe notification's title.

NotificationPayload.body

The notification's body text.

<b>Signature:</b>

typescript
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.

<b>Signature:</b>

typescript
icon?: string;

NotificationPayload.image

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

<b>Signature:</b>

typescript
image?: string;

NotificationPayload.title

The notification's title.

<b>Signature:</b>

typescript
title?: string;