docs: info about appBadge (#13716)

* docs: info about appBadge * update docs
tidev · Jan 13, 2023 · d8e3f78 · d8e3f78
1 parent 74b55e6
commit d8e3f78
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/apidoc/Titanium/UI/iOS/iOS.yml b/apidoc/Titanium/UI/iOS/iOS.yml
@@ -1088,6 +1088,16 @@ properties:
 
   - name: appBadge
     summary: Value of the badge for the application's springboard icon.
+    description: |
+        In order to change the app icon badge number you will need to register for notifications.
+        Normally this is done by using local notifications or a push service like [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) (FCM).
+        ``` js
+        Ti.App.iOS.registerUserNotificationSettings({
+          types: [
+                Ti.App.iOS.USER_NOTIFICATION_TYPE_BADGE
+            ]
+        });
+        ```
     type: Number
     since: "5.4.0"