Jump to top
Edit Page

Notification

interface

Properties

android

</>

Additional Android specific properties set on the notification.

android: undefined | { channelId: undefined | string, clickAction: undefined | string, color: undefined | string, count: undefined | number, imageUrl: undefined | string, link: undefined | string, priority: PRIORITY_MIN | PRIORITY_LOW | PRIORITY_DEFAULT | PRIORITY_HIGH | PRIORITY_MAX, smallIcon: undefined | string, sound: undefined | string, ticker: undefined | string, visibility: VISIBILITY_SECRET | VISIBILITY_PRIVATE | VISIBILITY_PUBLIC };

body

</>

The notification body content.

body: undefined | string;

bodyLocArgs

</>

Any arguments that should be formatted into the resource specified by bodyLocKey.

bodyLocArgs: string[];

bodyLocKey

</>

The native localization key for the notification body content.

bodyLocKey: undefined | string;

icon

</>

Web only. 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.

icon: undefined | string;

image

</>

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

image: undefined | string;

ios

</>
ios: undefined | { badge: undefined | string, sound: string | NotificationIOSCriticalSound, subtitle: undefined | string, subtitleLocArgs: string[], subtitleLocKey: undefined | string };

title

</>

The notification title. Web only. The notification's title.

title: undefined | string;

titleLocArgs

</>

Any arguments that should be formatted into the resource specified by titleLocKey.

titleLocArgs: string[];

titleLocKey

</>

The native localization key for the notification title.

titleLocKey: undefined | string;