[TIMOB-25045] Update documentation

tidev · Sep 22, 2017 · f790134 · f790134
1 parent cfab0a4
commit f790134
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/android/titanium/src/java/org/appcelerator/titanium/TiC.java b/android/titanium/src/java/org/appcelerator/titanium/TiC.java
@@ -1408,7 +1408,7 @@ public class TiC
 	/**
 	 * @module.api
 	 */
-	public static final String PROPERTY_ENABLE_VIBRATION = "enableVibrations";
+	public static final String PROPERTY_ENABLE_VIBRATION = "enableVibration";
 
 	/**
 	 * @module.api

diff --git a/apidoc/Titanium/Android/Android.yml b/apidoc/Titanium/Android/Android.yml
@@ -2305,42 +2305,49 @@ properties:
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_HIGH
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_LOW
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_MAX
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_MIN
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_NONE
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: IMPORTANCE_UNSPECIFIED
     summary: |
         Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level.
     type: Number
     permission: read-only
+    since: "7.0.0"
 
   - name: currentActivity
     summary: Activity of the active context.

diff --git a/apidoc/Titanium/Android/NotificationChannel.yml b/apidoc/Titanium/Android/NotificationChannel.yml
@@ -30,7 +30,7 @@ examples:
             Ti.Android.NotificationManager.notify(100, notification);
 
 extends: Titanium.Proxy
-since: "6.2.0"
+since: "7.0.0"
 osver: {android: {min: "8.0"}}
 platforms: [android]
 
@@ -40,7 +40,7 @@ properties:
     type: Boolean
 
   - name: description
-    summary: user visible description of this channel.
+    summary: User visible description of this channel.
     type: String
 
   - name: enableLights
@@ -58,8 +58,8 @@ properties:
   - name: importance
     summary: The audio stream type to use when playing the sound.
     description: Specify one of the `IMPORTANCE` constants from <Titanium.Android>.
-    constants: [Titanium.Android.IMPORTANCE_*]
     type: Number
+    constants: [Titanium.Android.IMPORTANCE_*]
 
   - name: id
     summary: The channel id specified for the notification channel.
@@ -72,11 +72,13 @@ properties:
   - name: lockscreenVisibility
     summary: Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.
     type: Number
+    constants: [Titanium.Android.VISIBILITY_*]
 
   - name: showBadge
     summary: Whether notifications posted to this channel can appear as application icon badges in a Launcher.
     type: Boolean
 
   - name: vibratePattern
     summary: The vibration pattern for notifications posted to this channel.
+    description: Specify the pattern in milliseconds as an array. (e.g [100, 100, 100, 400, 400, 100, 100, 100])
     type: Array<Number>
diff --git a/apidoc/Titanium/Android/NotificationManager/NotificationManager.yml b/apidoc/Titanium/Android/NotificationManager/NotificationManager.yml
@@ -40,6 +40,7 @@ methods:
   - name: createNotificationChannel
     osver: {android: {min: "8.0"}}
     summary: Create a notification channel.
+    description: This will return `null` when used on Android versions lower than 8.0.
     parameters:
       - name: parameters
         summary: Properties to set on a new object, including any defined by <Titanium.Android.NotificationChannel> except those marked not-creation or read-only.