ApnsConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
Represents the APNs-specific options that can be included in an Message. Refer to Apple documentation for various headers and payload fields supported by APNs.
Signature:
export interface ApnsConfig
Properties
| Property |
Type |
Description |
| fcmOptions |
ApnsFcmOptions |
Options for features provided by the FCM SDK for iOS. |
| headers |
{ [key: string]: string; } |
A collection of APNs headers. Header values must be strings. |
| payload |
ApnsPayload |
An APNs payload to be included in the message. |
ApnsConfig.fcmOptions
Options for features provided by the FCM SDK for iOS.
Signature:
fcmOptions?: ApnsFcmOptions;
A collection of APNs headers. Header values must be strings.
Signature:
headers?: {
[key: string]: string;
};
ApnsConfig.payload
An APNs payload to be included in the message.
Signature:
payload?: ApnsPayload;
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,["Represents the APNs-specific options that can be included in an [Message](./firebase-admin.messaging.md#message). Refer to [Apple documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for various headers and payload fields supported by APNs.\n\n**Signature:** \n\n export interface ApnsConfig \n\nProperties\n\nApnsConfig.fcmOptions\n\nOptions for features provided by the FCM SDK for iOS.\n\n**Signature:** \n\n fcmOptions?: ApnsFcmOptions;\n\nApnsConfig.headers\n\nA collection of APNs headers. Header values must be strings.\n\n**Signature:** \n\n headers?: {\n [key: string]: string;\n };\n\nApnsConfig.payload\n\nAn APNs payload to be included in the message.\n\n**Signature:** \n\n payload?: ApnsPayload;"]]
