Capacitor Plugins

For Android 8.0 (API 26) and higher, you should use notification channels. The SDK determines the channelId in this order:

1. The channelId explicitly set in the incoming FCM notification.
2. The default_notification_channel_id specified in AndroidManifest.xml.
3. The fallback channel provided by the Firebase SDK.

Warning: If you use option 1 or 2, you must still create the channel in your code using createChannel(...) with a matching ID. If you fail to do this, the SDK will fallback to the default Firebase channel.

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

The splash screen behavior can be managed via the Capacitor configuration file:

• Automatic Hiding: By default, the splash screen hides automatically after 500 ms.
• Manual Hiding: To prevent the splash screen from disappearing before your app is ready, set launchAutoHide to false. You must then call SplashScreen.hide() manually.
• Fixed Duration: To show the splash screen for a specific amount of time during launch, set launchShowDuration in your Capacitor configuration.

The Importance level defines the interruption level for notifications on Android. Values range from 0 to 5.

0 | 1 | 2 | 3 | 4 | 5

On Android, if the OS terminates your app while it is running a plugin that requires an external Activity (like the Camera), the result might be lost.

To prevent this, add a listener for appRestoredResult. When the app is relaunched, this listener will provide the result of the plugin call that was interrupted. This is highly recommended for any Android app using plugins that rely on external Activities.

App.addListener('appRestoredResult', (event) => {
  if (event.pluginId === 'Camera' && event.success) {
    console.log('Restored camera photo:', event.data);
  } else if (event.error) {
    console.error('Plugin call failed:', event.error.message);
  }
});

The InterruptionLevel determines the priority and delivery timing of a notification on iOS.

• active: Immediate presentation, lights up screen, plays sound.
• critical: Immediate presentation, lights up screen, bypasses mute switch. Requires Critical Alerts entitlement.
• passive: Added to notification list without lighting screen or playing sound.
• timeSensitive: Immediate presentation, lights up screen, plays sound, and breaks through system notification controls. Requires Time Sensitive Notifications capability.

'active' | 'critical' | 'passive' | 'timeSensitive'

iOS

This plugin does not support iOS Silent Push (Remote Notifications). You must use native code solutions for background updates.

Android

This plugin supports data-only notifications, but pushNotificationReceived will not be called if the app has been killed. To handle notifications when the app is killed, you must implement a custom service that extends FirebaseMessagingService.

Capacitor Labs contains experimental plugins. These are provided for testing and should be used at your own risk as they may undergo breaking changes or be removed.

• @capacitor/local-llm

When an Android device enters Doze mode, app capabilities are restricted. To ensure a notification fires even during Doze, set the allowWhileIdle option to true when scheduling.

Warning: Use allowWhileIdle judiciously, as these notifications can only fire once every 9 minutes per app.

To use the Device API in your Capacitor project, install the plugin via npm and then sync your project configuration.

npm install @capacitor/device
npx cap sync

To use the AppLauncher plugin, install the package via npm and sync your Capacitor project.

npm install @capacitor/app-launcher
npx cap sync

To use the Browser API in your Capacitor project, install the plugin via npm and sync your project.

npm install @capacitor/browser
npx cap sync