docs(notifications): Add links to explain the Android importance and …

…visibility values (ionic-team#584)
hmaretic24 · Aug 31, 2021 · 661c37b · 661c37b
1 parent 324ed86
commit 661c37b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -475,11 +475,15 @@ Remove all native listeners for this plugin.
 
 #### Importance
 
+The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
+
 <code>1 | 2 | 3 | 4 | 5</code>
 
 
 #### Visibility
 
+The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
+
 <code>-1 | 0 | 1</code>
 
 

diff --git a/src/definitions.ts b/src/definitions.ts
@@ -383,7 +383,16 @@ export interface Channel {
   vibration?: boolean;
 }
 
+/**
+ * The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
+ * @since 1.0.0
+ */
 export type Importance = 1 | 2 | 3 | 4 | 5;
+
+/**
+ * The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
+ * @since 1.0.0
+ */
 export type Visibility = -1 | 0 | 1;
 
 export interface ListChannelsResult {