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 %}

MessagePayload interface

Message payload that contains the notification payload that is represented with NotificationPayload and the data payload that contains an arbitrary number of key-value pairs sent by developers through the Send API<!-- -->.

<b>Signature:</b>

export interface MessagePayload 

Properties

MessagePayload.collapseKey

The collapse key of the message. See Non-collapsible and collapsible messages

<b>Signature:</b>

collapseKey: string;

MessagePayload.data

Arbitrary key/value payload.

<b>Signature:</b>

data?: {
        [key: string]: string;
    };

MessagePayload.fcmOptions

Options for features provided by the FCM SDK for Web. See WebpushFcmOptions<!-- -->.

<b>Signature:</b>

fcmOptions?: FcmOptions;

MessagePayload.from

The sender of this message.

<b>Signature:</b>

from: string;

MessagePayload.messageId

The message ID of a message.

<b>Signature:</b>

messageId: string;

MessagePayload.notification

Display notification details. Details are sent through the Send API<!-- -->.

<b>Signature:</b>

notification?: NotificationPayload;