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.
Signature:
export interface MessagePayload
Properties
Property | Type | Description |
---|---|---|
collapseKey | string | The collapse key of the message. See Non-collapsible and collapsible messages |
data | { [key: string]: string; } | Arbitrary key/value payload. |
fcmOptions | FcmOptions | Options for features provided by the FCM SDK for Web. See WebpushFcmOptions. |
from | string | The sender of this message. |
messageId | string | The message ID of a message. |
notification | NotificationPayload | Display notification details. Details are sent through the Send API. |
MessagePayload.collapseKey
The collapse key of the message. See Non-collapsible and collapsible messages
Signature:
collapseKey: string;
MessagePayload.data
Arbitrary key/value payload.
Signature:
data?: {
[key: string]: string;
};
MessagePayload.fcmOptions
Options for features provided by the FCM SDK for Web. See WebpushFcmOptions.
Signature:
fcmOptions?: FcmOptions;
MessagePayload.from
The sender of this message.
Signature:
from: string;
MessagePayload.messageId
The message ID of a message.
Signature:
messageId: string;
MessagePayload.notification
Display notification details. Details are sent through the Send API.
Signature:
notification?: NotificationPayload;