Implemented action button feature in foreground service notification

README.md

@@ -1,91 +1,103 @@
-
 # react-native-foreground-service
 
-A foreground service performs some operation that is noticeable to the user. 
-For example, an audio app would use a foreground service to play an audio track. 
-Foreground services must display a notification. 
+A foreground service performs some operation that is noticeable to the user.
+For example, an audio app would use a foreground service to play an audio track.
+Foreground services must display a notification.
 Foreground services continue running even when the user isn't interacting with the app.
 
 See [the Android official documentation](https://developer.android.com/guide/components/services) for details on the concept.
 
-
-## Getting started 
+## Getting started
 
 `$ npm install @voximplant/react-native-foreground-service --save`
 
 ### Automatic installation (Android only)
 
 - React Native 0.60+
 
-    CLI autolink feature links the module while building the app.
-
-    1. Add the FOREGROUND_SERVICE permission to the application's `AndroidManifest.xml`:
-        ```
-        <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
-        ```
-    2. Add VIForegroundService as a service to the application's `AndroidManifest.xml`:
-        ```
-        <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
+  CLI autolink feature links the module while building the app.
 
+  1. Add the FOREGROUND_SERVICE permission to the application's `AndroidManifest.xml`:
+     ```
+     <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+     ```
+  2. Add VIForegroundService as a service to the application's `AndroidManifest.xml`:
+     ```
+     <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
+     ```
 - React Native <= 0.59
 
-    `$ react-native link @voximplant/react-native-foreground-service`
+  `$ react-native link @voximplant/react-native-foreground-service`
 
-    1. Add the FOREGROUND_SERVICE permission to the application's `AndroidManifest.xml`:
-        ```
-        <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
-        ```
-    2. Add VIForegroundService as a service to the application's `AndroidManifest.xml`:
-        ```
-        <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
-        ```
+  1. Add the FOREGROUND_SERVICE permission to the application's `AndroidManifest.xml`:
+     ```
+     <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+     ```
+  2. Add VIForegroundService as a service to the application's `AndroidManifest.xml`:
+     ```
+     <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
+     ```
 
 ### Manual installation (Android only, React Native <= 0.59)
+
 1. Open up `android/app/src/main/java/[...]/MainActivity.java`
-    - Add `import com.voximplant.foregroundservice.VIForegroundServicePackage;` to the imports at the top of the file
-    - Add `new VIForegroundServicePackage()` to the list returned by the `getPackages()` method
+   - Add `import com.voximplant.foregroundservice.VIForegroundServicePackage;` to the imports at the top of the file
+   - Add `new VIForegroundServicePackage()` to the list returned by the `getPackages()` method
 2. Append the following lines to `android/settings.gradle`:
-  	```
-  	include ':@voximplant_react-native-foreground-service'
-    project(':@voximplant_react-native-foreground-service').projectDir = new File(rootProject.projectDir, '../node_modules/@voximplant/react-native-foreground-service/android')
-  	```
+   ```
+   include ':@voximplant_react-native-foreground-service'
+   project(':@voximplant_react-native-foreground-service').projectDir = new File(rootProject.projectDir, '../node_modules/@voximplant/react-native-foreground-service/android')
+   ```
 3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
-  	```
-    implementation project(':@voximplant_react-native-foreground-service')
-  	```
+   ```
+   implementation project(':@voximplant_react-native-foreground-service')
+   ```
 4. Add the FOREGROUND_SERVICE permission to the application's `AndroidManifest.xml`:
-    ```
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
-    ```
+   ```
+   <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+   ```
 5. Add VIForegroundService as a service to the application's `AndroidManifest.xml`:
-    ```
-    <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
-    ```
-
+   ```
+   <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
+   ```
+
+## Notification Action buttons
+To use action buttons in foreground notification add the following to the application's `AndroidManifest.xml`
+```
+<receiver android:name="com.voximplant.foregroundservice.NotificationHelper$NotificationBroadcastReceiver"
+         android:enabled="true"
+         android:exported="true" />
+```
+
 ## Demo project
+
 Demo application: [react-native-foreground-service-demo](https://github.com/voximplant/react-native-foreground-service-demo)
-  	
+
 ## Usage
 
 ### Import module
+
 ```javascript
-import VIForegroundService from '@voximplant/react-native-foreground-service';
+import VIForegroundService from "@voximplant/react-native-foreground-service";
 ```
 
 ### Create notification channel (Android 8+)
-Since the foreground service must display a notification, for Android 8+ it is required to create a notification 
+
+Since the foreground service must display a notification, for Android 8+ it is required to create a notification
 channel first:
+
 ```javascript
 const channelConfig = {
-    id: 'channelId',
-    name: 'Channel name',
-    description: 'Channel description',
-    enableVibration: false
+  id: "channelId",
+  name: "Channel name",
+  description: "Channel description",
+  enableVibration: false,
 };
 VIForegroundService.createNotificationChannel(channelConfig);
 ```
 
 ### Start foreground service
+
 ```javascript
 async startForegroundService() {
     const notificationConfig = {
@@ -104,54 +116,73 @@ async startForegroundService() {
 ```
 
 ### Stop foreground service
+
 ```javascript
 VIForegroundService.stopService();
 ```
 
 ## Reference
 
 ### Methods
+
 ```javascript
 static async startService(notificationConfig)
 ```
+
 Starts the foreground service and displays a notification with the defined configuration
 
-------------------------------
+---
 
 ```javascript
 static async stopService()
 ```
+
 Stops the foreground service
 
-------------------------------
+---
 
 ```javascript
 static async createNotificationChannel(channelConfig)
 ```
-Creates a notification channel for the foreground service. 
+
+Creates a notification channel for the foreground service.
 For Android 8+ the notification channel should be created before starting the foreground service
 
+```javascript
+static startListeners(callback)
+```
+Starts listening for action button events the callback is called with `event` parameter with field `actionLabel` which matches the `actionLabel` provided in config
+
+```javascript
+static async updateNotification(notificationConfig)
+```
+Updates foreground notification. You can update title, description, action button config. Accepts the updated notification config.
+> **Note: Make sure to keep `id` and `channelId` same as that of original notification config**
+
 ### Configs
+
 ```javascript
-NotificationChannelConfig
+NotificationChannelConfig;
 ```
-| Property name   | Description                                                                                                           | Required |
-|-----------------|-----------------------------------------------------------------------------------------------------------------------|----------|
-| id              | Unique channel id                                                                                                     | yes      |
-| name            | Notification channel name                                                                                             | yes      |
-| description     | Notification channel description                                                                                      | no       |
+
+| Property name   | Description                                                                                                                                                    | Required |
+| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| id              | Unique channel id                                                                                                                                              | yes      |
+| name            | Notification channel name                                                                                                                                      | yes      |
+| description     | Notification channel description                                                                                                                               | no       |
 | importance      | Notification channel importance. One of:<ul><li>1 – 'min'</li> <li>2 – 'low' (by default)</li><li>3 – 'default'</li><li>4 – 'high'</li><li>5 – 'max'</li></ul> | no       |
-| enableVibration | Sets whether notification posted to this channel should vibrate. False by default.                                    | no       |
+| enableVibration | Sets whether notification posted to this channel should vibrate. False by default.                                                                             | no       |
 
 ```javascript
-NotificationConfig
+NotificationConfig;
 ```
 
-| Property name | Description                                                                                                                                             | Required              |
-|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
-| channelId     | Notification channel id to display the notification                                                                                                     | yes (Android 8+ only) |
-| id            | Unique notification id                                                                                                                                  | yes                   |
-| title         | Notification title                                                                                                                                      | yes                   |
-| text          | Notification text                                                                                                                                       | yes                   |
-| icon          | Icon name                                                                                                                                               | yes                   |
-| priority      | Priority of this notification. One of: <ul><li>&nbsp;0 – PRIORITY_DEFAULT (by default)</li><li>-1 – PRIORITY_LOW</li><li>-2 – PRIORITY_MIN</li><li>&nbsp;1 – PRIORITY_HIGH</li><li>&nbsp;2 – PRIORITY_MAX</li></ul> | no       |
+| Property name | Description                                                                                                                                                                                                         | Required              |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
+| channelId     | Notification channel id to display the notification                                                                                                                                                                 | yes (Android 8+ only) |
+| id            | Unique notification id                                                                                                                                                                                              | yes                   |
+| title         | Notification title                                                                                                                                                                                                  | yes                   |
+| text          | Notification text                                                                                                                                                                                                   | yes                   |
+| icon          | Icon name                                                                                                                                                                                                           | yes                   |
+| priority      | Priority of this notification. One of: <ul><li>&nbsp;0 – PRIORITY_DEFAULT (by default)</li><li>-1 – PRIORITY_LOW</li><li>-2 – PRIORITY_MIN</li><li>&nbsp;1 – PRIORITY_HIGH</li><li>&nbsp;2 – PRIORITY_MAX</li></ul> | no                    |
+|actionButtons|Array of objects of type <br/> { label: String, id: number, actionLabel: string, redirect: boolean } <br/> for action buttons to be displayed in foreground notification where `label` is the display label on notification, `actionLabel` is the event param string emited when button is clicked and `redirect` is for whether to redirect to app when the button is clicked  |no

android/src/main/java/com/voximplant/foregroundservice/Constants.java

@@ -7,6 +7,7 @@
 class Constants {
     static final String ACTION_FOREGROUND_SERVICE_START = "com.voximplant.foregroundservice.service_start";
     static final String ACTION_FOREGROUND_SERVICE_STOP = "com.voximplant.foregroundservice.service_stop";
+    static final String ACTION_UPDATE_NOTIFICATION = "com.voximplant.foregroundservice.action_update_notification";
 
     static final String NOTIFICATION_CONFIG = "com.voximplant.foregroundservice.notif_config";