From e3790e876eba47b882ff3faca54ffc54b427891e Mon Sep 17 00:00:00 2001
From: Beng Tan <bengtan@users.noreply.github.com>
Date: Tue, 3 Sep 2019 14:10:16 +0800
Subject: [PATCH] Add docs for Notification channelImportance.

---
 src/declarations/interfaces/Notification.d.ts | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/src/declarations/interfaces/Notification.d.ts b/src/declarations/interfaces/Notification.d.ts
index 8e63fccf..4997b69c 100644
--- a/src/declarations/interfaces/Notification.d.ts
+++ b/src/declarations/interfaces/Notification.d.ts
@@ -473,5 +473,36 @@ declare module "react-native-background-geolocation" {
     */
     channelName?: string;
 
+    /**
+    * Configure the importance of the plugin's notification-channel used to display the [[Config.foregroundService]] notification.
+    * @break
+    * 
+    * On Android O+, the plugin's foreground-service needs to create a "Notification Channel". This will control the **importance** of the notification channel.
+    *
+    * The following `notificationPriority` values defined as static constants upon the [[BackgroundGeolocation]] object:
+    *
+    * | Value                                                   | Description                                                                                                       |
+    * |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
+    * | [[BackgroundGeolocation.NOTIFICATION_PRIORITY_DEFAULT]] | Default notification importance: shows everywhere, makes noise, but does not visually intrude.                    |
+    * | [[BackgroundGeolocation.NOTIFICATION_PRIORITY_HIGH]]    | Higher notification importance: shows everywhere, makes noise and peeks. May use full screen intents.             |
+    * | [[BackgroundGeolocation.NOTIFICATION_PRIORITY_LOW]]     | Low notification importance: Shows in the shade, and potentially in the status bar, but is not audibly intrusive. |
+    * | [[BackgroundGeolocation.NOTIFICATION_PRIORITY_MIN]]     | Min notification importance: Only shows in the shade, below the fold.                                             |
+    *
+    * @example
+    * ```javascript
+    * BackgroundGeolocation.ready({
+    *   notification: {
+    *     channelImportance: BackgroundGeolocation.NOTIFICATION_PRIORITY_LOW
+    * });
+    *
+    * // or with #setConfig
+    * BackgroundGeolocation.setConfig({
+    *   notification: {
+    *     channelImportance: BackgroundGeolocation.NOTIFICATION_PRIORITY_LOW
+    *   }
+    * });
+    * ```
+    */
+    channelImportance?: NotificationPriority
   }
 }