WebpushConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
Represents the WebPush protocol options that can be included in an Message.
Signature:
export interface WebpushConfig
Properties
WebpushConfig.data
A collection of data fields.
Signature:
data?: {
[key: string]: string;
};
WebpushConfig.fcmOptions
Options for features provided by the FCM SDK for Web.
Signature:
fcmOptions?: WebpushFcmOptions;
A collection of WebPush headers. Header values must be strings.
See WebPush specification for supported headers.
Signature:
headers?: {
[key: string]: string;
};
WebpushConfig.notification
A WebPush notification payload to be included in the message.
Signature:
notification?: WebpushNotification;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# WebpushConfig interface\n\nRepresents the WebPush protocol options that can be included in an [Message](./firebase-admin.messaging.md#message).\n\n**Signature:** \n\n export interface WebpushConfig \n\nProperties\n----------\n\n| Property | Type | Description |\n|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [data](./firebase-admin.messaging.webpushconfig.md#webpushconfigdata) | { \\[key: string\\]: string; } | A collection of data fields. |\n| [fcmOptions](./firebase-admin.messaging.webpushconfig.md#webpushconfigfcmoptions) | [WebpushFcmOptions](./firebase-admin.messaging.webpushfcmoptions.md#webpushfcmoptions_interface) | Options for features provided by the FCM SDK for Web. |\n| [headers](./firebase-admin.messaging.webpushconfig.md#webpushconfigheaders) | { \\[key: string\\]: string; } | A collection of WebPush headers. Header values must be strings.See [WebPush specification](https://tools.ietf.org/html/rfc8030#section-5) for supported headers. |\n| [notification](./firebase-admin.messaging.webpushconfig.md#webpushconfignotification) | [WebpushNotification](./firebase-admin.messaging.webpushnotification.md#webpushnotification_interface) | A WebPush notification payload to be included in the message. |\n\nWebpushConfig.data\n------------------\n\nA collection of data fields.\n\n**Signature:** \n\n data?: {\n [key: string]: string;\n };\n\nWebpushConfig.fcmOptions\n------------------------\n\nOptions for features provided by the FCM SDK for Web.\n\n**Signature:** \n\n fcmOptions?: WebpushFcmOptions;\n\nWebpushConfig.headers\n---------------------\n\nA collection of WebPush headers. Header values must be strings.\n\nSee [WebPush specification](https://tools.ietf.org/html/rfc8030#section-5) for supported headers.\n\n**Signature:** \n\n headers?: {\n [key: string]: string;\n };\n\nWebpushConfig.notification\n--------------------------\n\nA WebPush notification payload to be included in the message.\n\n**Signature:** \n\n notification?: WebpushNotification;"]]