Repository files navigation

The Push Notifications API provides access to native push notifications.

npm install @capacitor/push-notificationsnpx cap sync

On iOS you must enable the Push Notifications capability. SeeSetting Capabilities for instructions on how to enable the capability.

After enabling the Push Notifications capability, add the following to your app'sAppDelegate.swift:

func application(_ application:UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken:Data){NotificationCenter.default.post(name:.capacitorDidRegisterForRemoteNotifications, object: deviceToken)}func application(_ application:UIApplication, didFailToRegisterForRemoteNotificationsWithError error:Error){NotificationCenter.default.post(name:.capacitorDidFailToRegisterForRemoteNotifications, object: error)}

The Push Notification API usesFirebase Cloud Messaging SDK for handling notifications. SeeSet up a Firebase Cloud Messaging client app on Android and follow the instructions for creating a Firebase project and registering your application. There is no need to add the Firebase SDK to your app or edit your app manifest - the Push Notifications provides that for you. All that is required is your Firebase project'sgoogle-services.json file added to the module (app-level) directory of your app.

Android 13 requires a permission check in order to receive push notifications. You are required to callcheckPermissions() andrequestPermissions() accordingly, when targeting SDK 33.

This plugin will use the following project variables (defined in your app'svariables.gradle file):

• firebaseMessagingVersion version ofcom.google.firebase:firebase-messaging (default:23.3.1)

On Android, the Push Notifications icon with the appropriate name should be added to theAndroidManifest.xml file:

<meta-dataandroid:name="com.google.firebase.messaging.default_notification_icon"android:resource="@mipmap/push_icon_name" />

If no icon is specified Android will use the application icon, but push icon should be white pixels on a transparent backdrop. As the application icon is not usually like that, it will show a white square or circle. So it's recommended to provide the separate icon for Push Notifications.

Android Studio has an icon generator you can use to create your Push Notifications icon.

From Android 8.0 (API level 26) and higher, notification channels are supported and recommended. The SDK will derive thechannelId for incoming push notifications in the following order:

1. Firstly it will check if the incoming notification has achannelId set.When sending a push notification from either the FCM dashboard, or through their API, it's possible to specify achannelId.
2. Then it will check for a possible given value in theAndroidManifest.xml.If you prefer to create and use your own default channel, setdefault_notification_channel_id to the ID of your notification channel object as shown; FCM will use this value whenever incoming messages do not explicitly set a notification channel.

<meta-dataandroid:name="com.google.firebase.messaging.default_notification_channel_id"android:value="@string/default_notification_channel_id" />

3. Lastly it will use the fallbackchannelId that the Firebase SDK provides for us.FCM provides a default notification channel with basic settings out of the box. This channel will be created by the Firebase SDK upon receiving the first push message.

WarningWhen using option 1 or 2, you are still required to create a notification channel in code with an ID that matches the one used the chosen option. You can usecreateChannel(...) for this. If you don't do this, the SDK will fallback to option 3.

You can configure the way the push notifications are displayed when the app is in foreground.

Incapacitor.config.json:

{"plugins": {"PushNotifications": {"presentationOptions": ["badge","sound","alert"]    }  }}

Incapacitor.config.ts:

/// <reference types="@resgrid/push-notifications" />import{CapacitorConfig}from'@capacitor/cli';constconfig:CapacitorConfig={plugins:{PushNotifications:{presentationOptions:["badge","sound","alert"],},},};exportdefaultconfig;

This plugin does not support iOS Silent Push (Remote Notifications). We recommend using native code solutions for handling these types of notifications, seePushing Background Updates to Your App.

This plugin does support data-only notifications, but will NOT callpushNotificationReceived if the app has been killed. To handle this scenario, you will need to create a service that extendsFirebaseMessagingService, seeHandling FCM Messages.

On Android, there are various system and app states that can affect the delivery of push notifications:

• If the device has enteredDoze mode, your application may have restricted capabilities. To increase the chance of your notification being received, consider usingFCM high priority messages.
• There are differences in behavior between development and production. Try testing your app outside of being launched by Android Studio. Read morehere.

import{PushNotifications}from'@capacitor/push-notifications';constaddListeners=async()=>{awaitPushNotifications.addListener('registration',token=>{console.info('Registration token: ',token.value);});awaitPushNotifications.addListener('registrationError',err=>{console.error('Registration error: ',err.error);});awaitPushNotifications.addListener('pushNotificationReceived',notification=>{console.log('Push notification received: ',notification);});awaitPushNotifications.addListener('pushNotificationActionPerformed',notification=>{console.log('Push notification action performed',notification.actionId,notification.inputValue);});}constregisterNotifications=async()=>{letpermStatus=awaitPushNotifications.checkPermissions();if(permStatus.receive==='prompt'){permStatus=awaitPushNotifications.requestPermissions();}if(permStatus.receive!=='granted'){thrownewError('User denied permissions!');}awaitPushNotifications.register();}constgetDeliveredNotifications=async()=>{constnotificationList=awaitPushNotifications.getDeliveredNotifications();console.log('delivered notifications',notificationList);}

• register()
• unregister()
• getDeliveredNotifications()
• removeDeliveredNotifications(...)
• removeAllDeliveredNotifications()
• createChannel(...)
• deleteChannel(...)
• listChannels()
• checkPermissions()
• requestPermissions()
• addListener('registration', ...)
• addListener('registrationError', ...)
• addListener('pushNotificationReceived', ...)
• addListener('pushNotificationActionPerformed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

register()=>Promise<void>

Register the app to receive push notifications.

This method will trigger the'registration' event with the push token or'registrationError' if there was a problem. It does not prompt the user fornotification permissions, userequestPermissions() first.

Since: 1.0.0

unregister()=>Promise<void>

Unregister the app from push notifications.

This will delete a firebase token on Android, and unregister APNS on iOS.

Since: 5.0.0

getDeliveredNotifications()=>Promise<DeliveredNotifications>

Get a list of notifications that are visible on the notifications screen.

Returns:Promise<DeliveredNotifications>

Since: 1.0.0

removeDeliveredNotifications(delivered:DeliveredNotifications)=>Promise<void>

Remove the specified notifications from the notifications screen.

Since: 1.0.0

removeAllDeliveredNotifications()=>Promise<void>

Remove all the notifications from the notifications screen.

Since: 1.0.0

createChannel(channel:Channel)=>Promise<void>

Create a notification channel.

Only available on Android O or newer (SDK 26+).

Since: 1.0.0

deleteChannel(args:{id:string;})=>Promise<void>

Delete a notification channel.

Only available on Android O or newer (SDK 26+).

Since: 1.0.0

listChannels()=>Promise<ListChannelsResult>

List the available notification channels.

Only available on Android O or newer (SDK 26+).

Returns:Promise<ListChannelsResult>

Since: 1.0.0

checkPermissions()=>Promise<PermissionStatus>

Check permission to receive push notifications.

On Android 12 and below the status is always granted because you can alwaysreceive push notifications. If you need to check if the user allowsto display notifications, use local-notifications plugin.

Returns:Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()=>Promise<PermissionStatus>

Request permission to receive push notifications.

On Android 12 and below it doesn't prompt for permission because you can alwaysreceive push notifications.

On iOS, the first time you use the function, it will prompt the userfor push notification permission and return granted or denied basedon the user selection. On following calls it will get the current status ofthe permission without prompting again.

Returns:Promise<PermissionStatus>

Since: 1.0.0

addListener(eventName:'registration',listenerFunc:(token:Token)=>void)=>Promise<PluginListenerHandle>

Called when the push notification registration finishes without problems.

Provides the push notification token.

Returns:Promise<PluginListenerHandle>

Since: 1.0.0

addListener(eventName:'registrationError',listenerFunc:(error:RegistrationError)=>void)=>Promise<PluginListenerHandle>

Called when the push notification registration finished with problems.

Provides an error with the registration problem.

Returns:Promise<PluginListenerHandle>

Since: 1.0.0

addListener(eventName:'pushNotificationReceived',listenerFunc:(notification:PushNotificationSchema)=>void)=>Promise<PluginListenerHandle>

Called when the device receives a push notification.

Returns:Promise<PluginListenerHandle>

Since: 1.0.0

addListener(eventName:'pushNotificationActionPerformed',listenerFunc:(notification:ActionPerformed)=>void)=>Promise<PluginListenerHandle>

Called when an action is performed on a push notification.

Returns:Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()=>Promise<void>

Remove all native listeners for this plugin.

Since: 1.0.0

The importance level. For more details, see theAndroid Developer Docs

1 | 2 | 3 | 4 | 5

The notification visibility. For more details, see theAndroid Developer Docs

-1 | 0 | 1

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'