React Native Push Notification

https://github.com/zo0r/react-native-push-notification
Admin
A React Native library providing local and remote notification functionalities for both iOS and...
Tokens:14,573
Snippets:74
Trust Score:8.7
License:MIT
Update:11 months ago
Show doc for...
Tokens:
Raw
### Manual Android Setup for React Native Push Notification

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Instructions for manually integrating the react-native-push-notification library into an Android project by updating `settings.gradle` and `app/build.gradle` files. This method is used when autolinking is not employed.

```gradle
include ':react-native-push-notification'
project(':react-native-push-notification').projectDir = file('../node_modules/react-native-push-notification/android')
```

```gradle
dependencies {
    ...
    implementation project(':react-native-push-notification')
    ...
 }
```

--------------------------------

### Handle Notification Actions and User Input

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Configure notification actions (buttons) and handle user interactions, including inline text input. This example demonstrates setting up `onNotification` and `onAction` callbacks and creating notifications with different action types.

```javascript
import PushNotification from "react-native-push-notification";

// Configure notification with actions
PushNotification.configure({
  onNotification: function (notification) {
    console.log("Notification received:", notification);

    // Check notification state
    if (notification.foreground) {
      console.log("App in foreground");
    }
    if (notification.userInteraction) {
      console.log("User tapped notification");
    }

    notification.finish(PushNotificationIOS.FetchResult.NoData);
  },

  onAction: function (notification) {
    console.log("Action triggered:", notification.action);

    // Handle different actions
    switch (notification.action) {
      case 'Accept':
        handleAccept(notification.data);
        break;
      case 'Reject':
        handleReject(notification.data);
        break;
      case 'ReplyInput':
        // Handle inline reply
        const replyText = notification.reply_text;
        console.log("User replied:", replyText);
        sendReply(notification.data.messageId, replyText);
        break;
    }
  },

  permissions: { alert: true, badge: true, sound: true },
  popInitialNotification: true,
  requestPermissions: true,
});

// Create notification with inline reply (Android)
PushNotification.localNotification({
  channelId: "messages",
  title: "New Message",
  message: "John: Hey, are you coming?",
  actions: ["ReplyInput"],
  reply_placeholder_text: "Type your reply...",
  reply_button_text: "Send",
  userInfo: { messageId: "msg789", senderId: "john123" },
});

// Create notification with action buttons
PushNotification.localNotification({
  channelId: "requests",
  title: "Friend Request",
  message: "Jane Doe wants to connect with you",
  actions: ["Accept", "Reject"],
  invokeApp: true, // Open app when action is pressed
  userInfo: { requestId: "req456", userId: "jane123" },
});
```

--------------------------------

### Get Initial Notification in React Native

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Retrieves the initial notification that launched the application. This is useful for handling notifications that were received while the app was not running.

```javascript
PushNotification.popInitialNotification((notification) => {
  console.log('Initial Notification', notification);
});
```

--------------------------------

### Manage Permissions and App Badges

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Check, request, and manage notification permissions and application icon badge counts. This includes checking current permissions, requesting them manually, setting the badge number, getting the current badge count, clearing it, and abandoning permissions.

```javascript
import PushNotification from "react-native-push-notification";

// Check current permissions
PushNotification.checkPermissions((permissions) => {
  console.log("Permissions:", permissions);
  // Output: { alert: true, badge: true, sound: true }

  if (!permissions.alert) {
    console.log("Alert permission not granted");
    // Prompt user to enable notifications
  }
});

// Request permissions manually
PushNotification.requestPermissions()
  .then((permissions) => {
    console.log("Permissions granted:", permissions);
  })
  .catch((error) => {
    console.error("Permission request failed:", error);
  });

// Set badge number (iOS and some Android launchers)
PushNotification.setApplicationIconBadgeNumber(5);

// Get current badge number (iOS only)
PushNotification.getApplicationIconBadgeNumber((badgeCount) => {
  console.log("Current badge count:", badgeCount);
});

// Clear badge
PushNotification.setApplicationIconBadgeNumber(0);

// Abandon all permissions and unregister (iOS)
PushNotification.abandonPermissions();
```

--------------------------------

### Schedule Repeating Local Notification (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Schedules a local notification that repeats at a specified interval. This example demonstrates setting a daily repeat with a custom interval for Android. Note that 'repeatTime' is Android-only and has different behavior based on 'repeatType'.

```javascript
PushNotification.localNotificationSchedule({
    ... 
    repeatType: 'day',
    repeatTime: 2,
    ... 
});
```

--------------------------------

### Set iOS Notification Categories with Actions

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Configures notification categories for iOS, allowing custom actions like 'Reply' or 'Delete' to be attached to notifications. This setup requires importing the PushNotification module and defining an array of category objects, each with an ID and an array of action objects. The actions specify their own IDs, titles, and options such as foreground execution or destructive behavior. Subsequently, local notifications can be triggered with a specified category to leverage these predefined actions.

```javascript
import PushNotification from "react-native-push-notification";

// Define notification categories with actions
PushNotification.setNotificationCategories([
  {
    id: 'MESSAGE_CATEGORY',
    actions: [
      { id: 'reply', title: 'Reply', options: { foreground: true } },
      { id: 'delete', title: 'Delete', options: { destructive: true } }
    ]
  },
  {
    id: 'INVITATION_CATEGORY',
    actions: [
      { id: 'accept', title: 'Accept', options: { foreground: true } },
      { id: 'decline', title: 'Decline', options: { destructive: true } }
    ]
  }
]);

// Use category in notification
PushNotification.localNotification({
  title: "New Message",
  message: "You have a new message",
  category: "MESSAGE_CATEGORY",
  userInfo: { messageId: "msg123" }
});
```

--------------------------------

### Get Scheduled Local Notifications (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Fetches a list of local notifications that are scheduled to be displayed in the future. It takes a callback function that receives an array of notification objects, including their ID, scheduled date, title, message, and other relevant details.

```javascript
PushNotification.getScheduledLocalNotifications(callback);
```

--------------------------------

### Get Application Icon Badge Number (iOS)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This JavaScript function is specific to iOS and retrieves the current badge number displayed on the application icon. The result is returned via a callback function.

```javascript
PushNotification.getApplicationIconBadgeNumber(callback: Function) //Get badge number
```

--------------------------------

### Noisy Remote Push Notification Payload - JSON

Source: https://github.com/zo0r/react-native-push-notification/blob/master/trouble-shooting.md

An example JSON payload for sending a noisy remote push notification via Google Cloud Messaging (GCM). This payload includes notification details like title, body, and sound.

```json
{
  "to": "<token>",
  "time_to_live": 86400,
  "collapse_key": "new_message",
  "delay_while_idle": false,
  "notification": {
    "title": "title",
    "body": "this is a noisy test",
    "tag": "new_message",
    "icon": "new_message",
    "color": "#18d821",
    "sound": "default"
  }
}
```

--------------------------------

### Get Delivered Notifications (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Retrieves a list of notifications currently displayed in the device's notification center. It accepts a callback function that will be invoked with an array of notification objects, each containing details like identifier, title, body, and optional user data.

```javascript
PushNotification.getDeliveredNotifications(callback);
```

--------------------------------

### Cancel and Remove Notifications - JavaScript

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Provides functionality to cancel scheduled notifications by their ID, cancel all scheduled notifications, get a list of delivered notifications, remove specific delivered notifications, remove all delivered notifications, and retrieve scheduled notifications. This requires the 'react-native-push-notification' library.

```javascript
import PushNotification from "react-native-push-notification";

// Cancel specific notification by ID
PushNotification.cancelLocalNotification("12345");

// Cancel all scheduled notifications
PushNotification.cancelAllLocalNotifications();

// Get list of delivered notifications
PushNotification.getDeliveredNotifications((notifications) => {
  console.log("Delivered notifications:", notifications);
  // Output: Array of { identifier, title, body, category, userInfo, thread-id }
});

// Remove specific delivered notifications
PushNotification.removeDeliveredNotifications(["notification-id-1", "notification-id-2"]);

// Remove all delivered notifications
PushNotification.removeAllDeliveredNotifications();

// Get scheduled notifications
PushNotification.getScheduledLocalNotifications((notifications) => {
  console.log("Scheduled notifications:", notifications);
  notifications.forEach((notif) => {
    console.log(`ID: ${notif.id}, Title: ${notif.title}, Date: ${notif.date}`);
  });
});
```

--------------------------------

### Configure Push Notifications

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Initializes and configures the push notification system with event handlers and permissions. This function should be called at the entry point of your application (e.g., index.js) before any component lifecycle methods.

```APIDOC
## Configure Push Notifications

### Description
Initialize and configure the push notification system with event handlers and permissions. This must be called outside any component lifecycle, typically in index.js.

### Method
`PushNotification.configure(options)`

### Parameters
#### Request Body (options object)
- **onRegister** (function) - Required - Called when the device successfully registers for remote notifications. Receives a token object with `token` and `os` properties.
- **onNotification** (function) - Required - Called when a notification is received or opened. Receives a notification object. For iOS, `notification.finish(PushNotificationIOS.FetchResult.NoData)` is required for remote notifications.
- **onAction** (function) - Optional - Called when a notification action is pressed (Android only). Receives a notification object with an `action` property.
- **onRegistrationError** (function) - Optional - Called on registration error (iOS only). Receives an error object with a `message` property.
- **permissions** (object) - Optional - iOS permissions configuration. Can include `alert`, `badge`, `sound` (boolean).
- **popInitialNotification** (boolean) - Optional - Whether to show the initial notification automatically when the app loads.
- **requestPermissions** (boolean) - Optional - Whether to request permissions on initialization. Defaults to `true`.

### Request Example
```javascript
import PushNotification from "react-native-push-notification";
import PushNotificationIOS from "@react-native-community/push-notification-ios";

PushNotification.configure({
  onRegister: function (token) {
    console.log("TOKEN:", token);
    fetch('https://api.example.com/register', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ token: token.token, os: token.os })
    });
  },
  onNotification: function (notification) {
    console.log("NOTIFICATION:", notification);
    if (notification.userInteraction) {
      console.log("User opened notification");
    }
    notification.finish(PushNotificationIOS.FetchResult.NoData);
  },
  onAction: function (notification) {
    console.log("ACTION:", notification.action);
  },
  onRegistrationError: function(err) {
    console.error("Registration Error:", err.message);
  },
  permissions: {
    alert: true,
    badge: true,
    sound: true,
  },
  popInitialNotification: true,
  requestPermissions: true,
});
```

### Response
This method does not return a direct response. Configuration side effects include registering the device and setting up event handlers.
```

--------------------------------

### Configure Push Notifications in React Native

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Initializes the push notification system, setting up handlers for registration, notification reception, actions, and errors. It also manages permissions for iOS and determines whether to display initial notifications automatically. This configuration should be done once at the application's entry point.

```javascript
import PushNotification from "react-native-push-notification";
import PushNotificationIOS from "@react-native-community/push-notification-ios";

PushNotification.configure({
  // Called when device successfully registers for remote notifications
  onRegister: function (token) {
    console.log("TOKEN:", token);
    // Send token to your backend server
    fetch('https://api.example.com/register', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ token: token.token, os: token.os })
    });
  },

  // Called when notification is received or opened
  onNotification: function (notification) {
    console.log("NOTIFICATION:", notification);

    // Check if user tapped the notification
    if (notification.userInteraction) {
      console.log("User opened notification");
      // Navigate to specific screen based on notification.data
    }

    // Required for iOS remote notifications
    notification.finish(PushNotificationIOS.FetchResult.NoData);
  },

  // Called when notification action is pressed (Android)
  onAction: function (notification) {
    console.log("ACTION:", notification.action);

    if (notification.action === 'Accept') {
      // Handle accept action
    } else if (notification.action === 'Reject') {
      // Handle reject action
    }
  },

  // Called on registration error (iOS)
  onRegistrationError: function(err) {
    console.error("Registration Error:", err.message);
  },

  // iOS permissions
  permissions: {
    alert: true,
    badge: true,
    sound: true,
  },

  // Whether to show initial notification automatically
  popInitialNotification: true,

  // Request permissions on initialization
  requestPermissions: true,
});
```

--------------------------------

### Notification Configuration Options

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Optional parameters for configuring notification priority, visibility, and importance.

```APIDOC
## Notification Configuration Options

### Notification priority
(optional) Specify `priority` to set the priority of the notification. Default value: "high".

Available options:
- "max"
- "high"
- "low"
- "min"
- "default"

More information: https://developer.android.com/reference/android/app/Notification#PRIORITY_DEFAULT

### Notification visibility
(optional) Specify `visibility` to set the visibility of the notification. Default value: "private".

Available options:
- "private"
- "public"
- "secret"

More information: https://developer.android.com/reference/android/app/Notification#VISIBILITY_PRIVATE

### Notification importance
(optional) Specify `importance` to set the importance of the notification. Default value: `Importance.HIGH`.

Import using: `import PushNotification, {Importance} from 'react-native-push-notification';`

Available options:
- `Importance.DEFAULT`
- `Importance.HIGH`
- `Importance.LOW`
- `Importance.MIN`
- `Importance.NONE`
- `Importance.UNSPECIFIED`

More information: https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT
```

--------------------------------

### Create Local Notification

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Displays an immediate local notification with customizable properties for both Android and iOS platforms.

```APIDOC
## Create Local Notification

### Description
Display an immediate local notification with custom styling and content. This function supports platform-specific properties for Android and iOS, as well as cross-platform options.

### Method
`PushNotification.localNotification(notificationProperties)`

### Parameters
#### Request Body (notificationProperties object)
**Android Properties**
- **channelId** (string) - Required for Android - The ID of the notification channel to use.
- **ticker** (string) - Optional - Text to display in the ticker.
- **showWhen** (boolean) - Optional - Whether to show the time when the notification was created.
- **autoCancel** (boolean) - Optional - Whether the notification should be automatically canceled when the user taps it.
- **largeIcon** (string) - Optional - The name of the large icon resource.
- **smallIcon** (string) - Optional - The name of the small icon resource.
- **bigText** (string) - Optional - The text to display in the expanded notification.
- **subText** (string) - Optional - Text to display below the title.
- **color** (string) - Optional - The color of the notification icon and header.
- **vibrate** (boolean) - Optional - Whether the notification should vibrate.
- **vibration** (number) - Optional - The duration of the vibration in milliseconds.
- **priority** (string) - Optional - The priority of the notification (e.g., 'high', 'default', 'low').
- **visibility** (string) - Optional - The visibility of the notification (e.g., 'private', 'public', 'secret').
- **ignoreInForeground** (boolean) - Optional - Whether to ignore the notification when the app is in the foreground.
- **actions** (array of strings) - Optional - An array of strings representing the actions to display on the notification.
- **invokeApp** (boolean) - Optional - Whether to invoke the app when the notification is tapped.

**iOS Properties**
- **category** (string) - Optional - The notification category for custom actions.
- **subtitle** (string) - Optional - The subtitle displayed below the title.

**Cross-platform Properties**
- **id** (string or number) - Optional - A unique identifier for the notification. If not provided, a random ID will be generated.
- **title** (string) - Optional - The title of the notification.
- **message** (string) - Required - The main content of the notification.
- **userInfo** (object) - Optional - Custom data to be sent with the notification.
- **playSound** (boolean) - Optional - Whether to play a sound when the notification is received.
- **soundName** (string) - Optional - The name of the sound file to play.
- **number** (number) - Optional - The badge count for the app icon.

### Request Example
```javascript
import PushNotification from "react-native-push-notification";

// Create a notification channel (Android only, but required)
PushNotification.createChannel(
  {
    channelId: "default-channel",
    channelName: "Default Channel",
    channelDescription: "Default notification channel",
    playSound: true,
    soundName: "default",
    importance: 4, // HIGH
    vibrate: true,
  },
  (created) => console.log(`Channel created: ${created}`)
);

// Display local notification
PushNotification.localNotification({
  /* Android Properties */
  channelId: "default-channel", 
  ticker: "New Message",
  showWhen: true,
  autoCancel: true,
  largeIcon: "ic_launcher",
  smallIcon: "ic_notification",
  bigText: "This is a longer notification message.",
  subText: "New",
  color: "blue",
  vibrate: true,
  vibration: 300,
  priority: "high",
  visibility: "private",
  ignoreInForeground: false,
  actions: ["Accept", "Reject"],
  invokeApp: true,

  /* iOS Properties */
  category: "MESSAGE_CATEGORY",
  subtitle: "From John Doe",

  /* Cross-platform Properties */
  id: "12345",
  title: "New Message",
  message: "You have a new message from John Doe",
  userInfo: { userId: "user123", messageId: "msg456" },
  playSound: true,
  soundName: "default",
  number: 10,
});
```

### Response
This method does not return a direct response. The local notification is displayed to the user.
```

--------------------------------

### Configure AndroidManifest.xml for Push Notifications

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Defines necessary permissions (VIBRATE, RECEIVE_BOOT_COMPLETED) and configures application metadata for push notification behavior, including foreground notification display and accent color. Registers essential broadcast receivers and the notification listener service.

```xml
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>

<application ....>
    <!-- Change the value to true to enable pop-up for in foreground on receiving remote notifications (for prevent duplicating while showing local notifications set this to false) -->
    <meta-data  android:name="com.dieam.reactnativepushnotification.notification_foreground"
                android:value="false"/>
    <!-- Change the resource name to your App's accent color - or any other color you want -->
    <meta-data  android:name="com.dieam.reactnativepushnotification.notification_color"
                android:resource="@color/white"/> <!-- or @android:color/{name} to use a standard color -->

    <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationActions" />
    <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />
    <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
        <intent-filter>
            <action android:name="android.intent.action.BOOT_COMPLETED" />
            <action android:name="android.intent.action.QUICKBOOT_POWERON" />
            <action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
        </intent-filter>
    </receiver>

    <service
        android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"
        android:exported="false" >
        <intent-filter>
            <action android:name="com.google.firebase.MESSAGING_EVENT" />
        </intent-filter>
    </service>
 .....
```

--------------------------------

### Handle Initial Notification When App is Closed

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Retrieve and process a notification that was used to launch the application when it was in a closed or background state. This is useful for navigating the user to a specific screen based on the notification's content.

```javascript
import PushNotification from "react-native-push-notification";

// Get initial notification (if app was opened from notification)
PushNotification.popInitialNotification((notification) => {
  if (notification) {
    console.log('Initial Notification:', notification);

    // Navigate to specific screen based on notification data
    if (notification.data && notification.data.screen) {
      navigation.navigate(notification.data.screen, {
        id: notification.data.id
      });
    }
  } else {
    console.log('App opened normally (not from notification)');
  }
});
```

--------------------------------

### Configure Inline Reply Notification Action (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Configures a local notification with an inline reply action. This allows users to respond directly from the notification. It requires specifying 'ReplyInput' as an action and providing placeholder and button text. The reply text can be accessed via 'notification.reply_text'.

```javascript
PushNotification.localNotificationSchedule({
  message: "My Notification Message", // (required)
  date: new Date(Date.now() + (60 * 1000)), // in 60 secs
  actions: ["ReplyInput"],
  reply_placeholder_text: "Write your response...", // (required)
  reply_button_text: "Reply" // (required)
});

// To get the text from the notification:
// ...
// if(notification.action === "ReplyInput"){
//   console.log("texto", notification.reply_text) // this will contain the inline reply text. 
// }
// ...
```

--------------------------------

### Manually Registering Push Notification Module in Android

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This Java code snippet demonstrates how to manually register the `ReactNativePushNotificationPackage` within the `MainApplication.java` file for Android projects. This is necessary when `react-native link` is not used.

```java
import com.dieam.reactnativepushnotification.ReactNativePushNotificationPackage;  // <--- Import Package

public class MainApplication extends Application implements ReactApplication {

  private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
      @Override
      protected boolean getUseDeveloperSupport() {
        return BuildConfig.DEBUG;
      }

      @Override
      protected List<ReactPackage> getPackages() {

          return Arrays.<ReactPackage>asList(
              new MainReactPackage(),
              new ReactNativePushNotificationPackage() // <---- Add the Package
          );
    }
  };

  ....
}
```

--------------------------------

### Add Firebase Analytics and Apply Google Services Plugin

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Includes the Firebase Analytics dependency in the app-level `build.gradle` file and applies the Google Services plugin. This enables Firebase Analytics and other Firebase features, requiring the `google-services.json` file to be placed in the `android/app/` directory.

```gradle
dependencies {
  ...
  implementation 'com.google.firebase:firebase-analytics:17.3.0'
  ...
}

apply plugin: 'com.google.gms.google-services'

```

--------------------------------

### Configure Android Build Gradle for Push Notifications

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Sets project-level versions for Google Play services, Firebase Messaging, compile SDK, build tools, target SDK, and support libraries. Ensures compatibility between Firebase and push notification components.

```gradle
ext {
    googlePlayServicesVersion = "<Your play services version>" // default: "+"
    firebaseMessagingVersion = "<Your Firebase version>" // default: "21.1.0"

    // Other settings
    compileSdkVersion = <Your compile SDK version> // default: 23
    buildToolsVersion = "<Your build tools version>" // default: "23.0.1"
    targetSdkVersion = <Your target SDK version> // default: 23
    supportLibVersion = "<Your support lib version>" // default: 23.1.1
}
```

--------------------------------

### Define Custom Color Resource for Notifications

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Creates or updates the `colors.xml` file to define custom color resources, such as 'white', for use in the application's notification configurations. This is required when not using a standard Android color.

```xml
<resources>
    <color name="white">#FFF</color>
</resources>
```

--------------------------------

### Configure Firebase Services in Android Build Gradle

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Adds the Google Services Gradle plugin dependency to the project's root `build.gradle` file. This is a prerequisite for integrating Firebase services into the Android application.

```gradle
buildscript {
    ...
    dependencies {
        ...
        classpath('com.google.gms:google-services:4.3.3')
        ...
    }
}
```

--------------------------------

### Create Notification Channel on Android

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Creates a notification channel for Android devices, which is required for notifications to function. It allows categorizing notifications and setting properties like importance and vibration.

```javascript
import PushNotification, {Importance} from 'react-native-push-notification';
...
  PushNotification.createChannel(
    {
      channelId: "channel-id", // (required)
      channelName: "My channel", // (required)
      channelDescription: "A channel to categorise your notifications", // (optional) default: undefined.
      playSound: false, // (optional) default: true
      soundName: "default", // (optional) See `soundName` parameter of `localNotification` function
      importance: Importance.HIGH, // (optional) default: Importance.HIGH. Int value of the Android notification importance
      vibrate: true, // (optional) default: true. Creates the default vibration pattern if true.
    },
    (created) => console.log(`createChannel returned '${created}'`) // (optional) callback returns whether the channel was created, false means it already existed.
  );
```

--------------------------------

### Create Local Notification in React Native

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Creates a notification channel for Android and then displays a local notification. This notification can include various platform-specific properties for Android (like ticker, icons, and actions) and iOS (like subtitle and category), as well as cross-platform settings for title, message, and badges.

```javascript
import PushNotification from "react-native-push-notification";

// First, create a notification channel (Android only, but required)
PushNotification.createChannel(
  {
    channelId: "default-channel",
    channelName: "Default Channel",
    channelDescription: "Default notification channel",
    playSound: true,
    soundName: "default",
    importance: 4, // HIGH
    vibrate: true,
  },
  (created) => console.log(`Channel created: ${created}`)
);

// Display local notification
PushNotification.localNotification({
  /* Android Properties */
  channelId: "default-channel", // required for Android
  ticker: "New Message",
  showWhen: true,
  autoCancel: true,
  largeIcon: "ic_launcher",
  smallIcon: "ic_notification",
  bigText: "This is a longer notification message that will be expanded when the user pulls down the notification shade. You can include <b>HTML tags</b> for styling.",
  subText: "New",
  color: "blue",
  vibrate: true,
  vibration: 300,
  priority: "high",
  visibility: "private",
  ignoreInForeground: false,
  actions: ["Accept", "Reject"],
  invokeApp: true,

  /* iOS Properties */
  category: "MESSAGE_CATEGORY",
  subtitle: "From John Doe",

  /* Cross-platform Properties */
  id: "12345",
  title: "New Message",
  message: "You have a new message from John Doe",
  userInfo: { userId: "user123", messageId: "msg456" },
  playSound: true,
  soundName: "default",
  number: 10, // Badge count
});
```

--------------------------------

### Configure Push Notifications in React Native

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This JavaScript code configures the `react-native-push-notification` library. It includes essential callbacks for token registration, receiving notifications, handling actions, and managing registration errors. It is crucial to place this configuration outside of any component's lifecycle methods.

```javascript
import PushNotificationIOS from "@react-native-community/push-notification-ios";
import PushNotification from "react-native-push-notification";

// Must be outside of any component LifeCycle (such as `componentDidMount`).
PushNotification.configure({
  // (optional) Called when Token is generated (iOS and Android)
  onRegister: function (token) {
    console.log("TOKEN:", token);
  },

  // (required) Called when a remote is received or opened, or local notification is opened
  onNotification: function (notification) {
    console.log("NOTIFICATION:", notification);

    // process the notification

    // (required) Called when a remote is received or opened, or local notification is opened
    notification.finish(PushNotificationIOS.FetchResult.NoData);
  },

  // (optional) Called when Registered Action is pressed and invokeApp is false, if true onNotification will be called (Android)
  onAction: function (notification) {
    console.log("ACTION:", notification.action);
    console.log("NOTIFICATION:", notification);

    // process the action
  },

  // (optional) Called when the user fails to register for remote notifications. Typically occurs when APNS is having issues, or the device is a simulator. (iOS)
  onRegistrationError: function(err) {
    console.error(err.message, err);
  },

  // IOS ONLY (optional): default: all - Permissions to register.
  permissions: {
    alert: true,
    badge: true,
    sound: true,
  },

  // Should the initial notification be popped automatically
  // default: true
  popInitialNotification: true,

  /**
   * (optional) default: true
   * - Specified if permissions (ios) and token (android and ios) will requested or not,
   * - if not, you must call PushNotificationsHandler.requestPermissions() later
   * - if you are not using remote notification or do not have Firebase installed, use this:
   *     requestPermissions: Platform.OS === 'ios'
   */
  requestPermissions: true,
});
```

--------------------------------

### React Native Push Notification Payload Structure

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This JavaScript object demonstrates the structure of a notification payload received by the `onNotification` callback. It includes properties like `foreground`, `userInteraction`, `message`, and `data`, providing information about how and when the notification was received or interacted with.

```javascript
{
    foreground: false, // BOOLEAN: If the notification was received in foreground or not
    userInteraction: false, // BOOLEAN: If the notification was opened by the user from the notification area or not
    message: 'My Notification Message', // STRING: The notification message
    data: {}, // OBJECT: The push data or the defined userInfo in local notifications
}
```

--------------------------------

### Manage Notification Channels (Android) - JavaScript

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Manages notification channels for Android, allowing creation, listing, checking existence, checking if blocked, and deletion of channels. This is crucial for categorizing notifications and user control. It requires the 'react-native-push-notification' library and utilizes specific channel management functions.

```javascript
import PushNotification, { Importance } from 'react-native-push-notification';

// Create a high-priority channel
PushNotification.createChannel(
  {
    channelId: "urgent-alerts",
    channelName: "Urgent Alerts",
    channelDescription: "High priority notifications for urgent matters",
    playSound: true,
    soundName: "urgent.mp3",
    importance: Importance.HIGH,
    vibrate: true,
  },
  (created) => {
    if (created) {
      console.log("Channel created successfully");
    } else {
      console.log("Channel already exists");
    }
  }
);

// List all channels
PushNotification.getChannels(function (channelIds) {
  console.log("Available channels:", channelIds);
  // Output: ['urgent-alerts', 'default-channel']
});

// Check if specific channel exists
PushNotification.channelExists("urgent-alerts", function (exists) {
  if (exists) {
    console.log("Channel exists");
  }
});

// Check if channel is blocked by user
PushNotification.channelBlocked("urgent-alerts", function (blocked) {
  if (blocked) {
    console.log("User has blocked this channel");
    // Guide user to enable notifications in settings
  }
});

// Delete a channel
PushNotification.deleteChannel("old-channel-id");
```

--------------------------------

### Schedule Local Notification with Valid Date - JavaScript

Source: https://github.com/zo0r/react-native-push-notification/blob/master/trouble-shooting.md

Demonstrates how to correctly schedule a local notification with a valid Date object in JavaScript for React Native. Avoids issues with string-based date parsing.

```javascript
const date = new Date("10-10-2020 12:30");
```

```javascript
const hour = 12;
const minute = 30;
const second = 0;

const now = new Date();
const date = new Date(
  now.getFullYear(),
  now.getMonth(),
  now.getDate(),
  hour,
  minute,
  second
);
```

--------------------------------

### Schedule Local Notification with React Native Push Notification

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This JavaScript code snippet demonstrates how to schedule a local notification using the `PushNotification.localNotification` method. It includes numerous optional properties specific to Android and iOS, such as channel IDs, large icons, custom sounds, subtitles, and repeating intervals. Ensure proper configuration of channel IDs for Android to guarantee notification delivery.

```javascript
PushNotification.localNotification({
  /* Android Only Properties */
  channelId: "your-channel-id", // (required) channelId, if the channel doesn't exist, notification will not trigger.
  ticker: "My Notification Ticker", // (optional)
  showWhen: true, // (optional) default: true
  autoCancel: true, // (optional) default: true
  largeIcon: "ic_launcher", // (optional) default: "ic_launcher". Use "" for no large icon.
  largeIconUrl: "https://www.example.tld/picture.jpg", // (optional) default: undefined
  smallIcon: "ic_notification", // (optional) default: "ic_notification" with fallback for "ic_launcher". Use "" for default small icon.
  bigText: "My big text that will be shown when notification is expanded. Styling can be done using HTML tags(see android docs for details)", // (optional) default: "message" prop
  subText: "This is a subText", // (optional) default: none
  bigPictureUrl: "https://www.example.tld/picture.jpg", // (optional) default: undefined
  bigLargeIcon: "ic_launcher", // (optional) default: undefined
  bigLargeIconUrl: "https://www.example.tld/bigicon.jpg", // (optional) default: undefined
  color: "red", // (optional) default: system default
  vibrate: true, // (optional) default: true
  vibration: 300, // vibration length in milliseconds, ignored if vibrate=false, default: 1000
  tag: "some_tag", // (optional) add tag to message
  group: "group", // (optional) add group to message
  groupSummary: false, // (optional) set this notification to be the group summary for a group of notifications, default: false
  ongoing: false, // (optional) set whether this is an "ongoing" notification
  priority: "high", // (optional) set notification priority, default: high
  visibility: "private", // (optional) set notification visibility, default: private
  ignoreInForeground: false, // (optional) if true, the notification will not be visible when the app is in the foreground (useful for parity with how iOS notifications appear). should be used in combine with `com.dieam.reactnativepushnotification.notification_foreground` setting
  shortcutId: "shortcut-id", // (optional) If this notification is duplicative of a Launcher shortcut, sets the id of the shortcut, in case the Launcher wants to hide the shortcut, default undefined
  onlyAlertOnce: false, // (optional) alert will open only once with sound and notify, default: false
  
  when: null, // (optional) Add a timestamp (Unix timestamp value in milliseconds) pertaining to the notification (usually the time the event occurred). For apps targeting Build.VERSION_CODES.N and above, this time is not shown anymore by default and must be opted into by using `showWhen`, default: null.
  usesChronometer: false, // (optional) Show the `when` field as a stopwatch. Instead of presenting `when` as a timestamp, the notification will show an automatically updating display of the minutes and seconds since when. Useful when showing an elapsed time (like an ongoing phone call), default: false.
  timeoutAfter: null, // (optional) Specifies a duration in milliseconds after which this notification should be canceled, if it is not already canceled, default: null

  messageId: "google:message_id", // (optional) added as `message_id` to intent extras so opening push notification can find data stored by @react-native-firebase/messaging module. 

  actions: ["Yes", "No"], // (Android only) See the doc for notification actions to know more
  invokeApp: true, // (optional) This enable click on actions to bring back the application to foreground or stay in background, default: true

  /* iOS only properties */
  category: "", // (optional) default: empty string
  subtitle: "My Notification Subtitle", // (optional) smaller title below notification title

  /* iOS and Android properties */
  id: 0, // (optional) Valid unique 32 bit integer specified as string. default: Autogenerated Unique ID
  title: "My Notification Title", // (optional)
  message: "My Notification Message", // (required)
  picture: "https://www.example.tld/picture.jpg", // (optional) Display an picture with the notification, alias of `bigPictureUrl` for Android. default: undefined
  userInfo: {}, // (optional) default: {} (using null throws a JSON value '<null>' error)
  playSound: false, // (optional) default: true
  soundName: "default", // (optional) Sound to play when the notification is shown. Value of 'default' plays the default sound. It can be set to a custom sound such as 'android.resource://com.xyz/raw/my_sound'. It will look for the 'my_sound' audio file in 'res/raw' directory and play it. default: 'default' (default sound is played)
  number: 10, // (optional) Valid 32 bit integer specified as string. default: none (Cannot be zero)
  repeatType: "day", // (optional) Repeating interval. Check 'Repeating Notifications' section for more info.
});

```

--------------------------------

### List Notification Channels on Android

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Retrieves a list of all available notification channel IDs on an Android device. This is useful for managing or inspecting existing channels.

```javascript
PushNotification.getChannels(function (channel_ids) {
  console.log(channel_ids);
});
```

--------------------------------

### Schedule Local Notification - JavaScript

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Schedules local notifications to appear at a specific time with optional repeating intervals. This function requires the 'react-native-push-notification' library and accepts parameters like title, message, date, and repeat types. It can be used for reminders or time-based alerts.

```javascript
import PushNotification from "react-native-push-notification";

// Schedule notification for 60 seconds from now
PushNotification.localNotificationSchedule({
  channelId: "default-channel",
  title: "Reminder",
  message: "Time to take your medication",
  date: new Date(Date.now() + 60 * 1000), // 60 seconds
  allowWhileIdle: true, // Android: work during doze mode

  /* Repeating notification */
  repeatType: "day", // 'day', 'week', 'month', 'hour', 'minute', 'time'
  repeatTime: 1, // Android only: repeat every 1 day

  id: "medication-reminder",
  userInfo: { type: "medication", dosage: "10mg" },
  playSound: true,
  soundName: "alarm.mp3",
  actions: ["Take Now", "Snooze"],
});

// Schedule notification for specific date and time
const scheduledDate = new Date(2025, 11, 25, 9, 0, 0); // Dec 25, 2025 at 9:00 AM
PushNotification.localNotificationSchedule({
  channelId: "default-channel",
  title: "Merry Christmas!",
  message: "Have a wonderful holiday season",
  date: scheduledDate,
  id: "christmas-greeting",
});
```

--------------------------------

### Android Manifest Receiver Declaration (XML)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Declares the necessary receiver in the AndroidManifest.xml file to handle notification actions. This is crucial for the proper functioning of notification actions, especially for background handling.

```xml
  <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationActions" />
```

--------------------------------

### abandonPermissions

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Revokes notification permissions and unregisters the device for remote notifications.

```APIDOC
## abandonPermissions

### Description
Revokes the current token and unregisters for all remote notifications received via APNS or FCM.

### Method
N/A (JavaScript function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```javascript
PushNotification.abandonPermissions();
```

### Response
None
```

--------------------------------

### Set Application Icon Badge Number (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Sets the badge count for the application's icon. This functionality is native to iOS and uses the ShortcutBadger library on Android, which may not be supported on all devices.

```javascript
PushNotification.setApplicationIconBadgeNumber(number: number)
```

--------------------------------

### Check Notification Permissions in React Native

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

This JavaScript snippet shows how to check the current notification permissions (alert, badge, sound) for your React Native application. The `PushNotification.checkPermissions` method takes a callback function that receives a permissions object.

```javascript
PushNotification.checkPermissions(callback: Function) //Check permissions
```

--------------------------------

### Override onNewIntent in MainActivity.java

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Ensures that the `onNewIntent` method in `MainActivity.java` includes a call to `super.onNewIntent(intent)` if it is overridden. This is crucial for correctly handling intent updates when the activity is already running.

```java
@Override
public void onNewIntent(Intent intent) {
    ...
    super.onNewIntent(intent);
    ...
}
```

--------------------------------

### Subscribe to Push Notification Topic (JavaScript)

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Subscribes the device to a specific push notification topic. This method is specific to Android and is intended for use with Firebase Cloud Messaging.

```javascript
PushNotification.subscribeToTopic(topic: string)
```

--------------------------------

### Subscribe to FCM Topics (Android)

Source: https://context7.com/zo0r/react-native-push-notification/llms.txt

Enable subscribing and unsubscribing from Firebase Cloud Messaging topics on Android. This allows for targeted push notifications to specific user segments based on their interests.

```javascript
import PushNotification from "react-native-push-notification";

// Subscribe to a topic
PushNotification.subscribeToTopic("news");
PushNotification.subscribeToTopic("sports");

// Unsubscribe from a topic
PushNotification.unsubscribeFromTopic("sports");

// Example: Subscribe based on user preferences
const userPreferences = {
  news: true,
  sports: false,
  entertainment: true
};

Object.keys(userPreferences).forEach((topic) => {
  if (userPreferences[topic]) {
    PushNotification.subscribeToTopic(topic);
  } else {
    PushNotification.unsubscribeFromTopic(topic);
  }
});
```

--------------------------------

### Schedule Local Notifications in React Native

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Schedules a local notification to be delivered at a specific time. This function accepts all options available for local notifications, along with Android-specific properties like `repeatTime`.

```javascript
PushNotification.localNotificationSchedule({
  //... You can use all the options from localNotifications
  message: "My Notification Message", // (required)
  date: new Date(Date.now() + 60 * 1000), // in 60 secs
  allowWhileIdle: false, // (optional) set notification to work while on doze, default: false

  /* Android Only Properties */
  repeatTime: 1, // (optional) Increment of configured repeatType. Check 'Repeating Notifications' section for more info.
});
```

--------------------------------

### getDeliveredNotifications

Source: https://github.com/zo0r/react-native-push-notification/blob/master/README.md

Retrieves a list of notifications currently displayed in the Notification Center.

```APIDOC
## getDeliveredNotifications

### Description
Provides a list of the app’s notifications that are still displayed in Notification Center.

### Method
N/A (JavaScript function call)

### Endpoint
N/A

### Parameters
#### Query Parameters
- **callback** (function) - Required - Function which receive an array of delivered notifications.

### Request Example
```javascript
PushNotification.getDeliveredNotifications(callback);
```

### Response
#### Success Response
An array of delivered notification objects, each containing:
- **identifier** (string) - The identifier of this notification.
- **title** (string) - The title of this notification.
- **body** (string) - The body of this notification.
- **category** (string) - The category of this notification (optional).
- **userInfo** (object) - An object containing additional notification data (optional).
- **thread-id** (string) - The thread identifier of this notification, if has one.

#### Response Example
```json
[
  {
    "identifier": "123e4567-e89b-12d3-a456-426614174000",
    "title": "New Message",
    "body": "You have a new message from John.",
    "category": "message",
    "userInfo": {"customKey": "customValue"},
    "thread-id": "thread-1"
  }
]
```
```
Tokens:
Raw