[docs] add note about permission for notification badge setting on iOS

duogenesis · Oct 15, 2021 · 1c83b7b · 1c83b7b
1 parent 54ea183
commit 1c83b7b
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/pages/versions/unversioned/sdk/notifications.md b/docs/pages/versions/unversioned/sdk/notifications.md
@@ -857,7 +857,7 @@ It returns a `Promise` resolving to a number representing current badge of the a
 
 ### `setBadgeCountAsync(badgeCount: number, options?: SetBadgeCountOptions): Promise<boolean>`
 
-Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge.
+Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge. On iOS, this method requires that you have requested the user's permission for `allowBadge` via [`requestPermissionsAsync`](#requestpermissionsasyncrequest-notificationpermissionsrequest-promisenotificationpermissionsstatus), otherwise it will automatically return `false`.
 
 > **Note:** Not all Android launchers support application badges. If the launcher does not support icon badges, the method will resolve to `false`.
 

diff --git a/docs/pages/versions/v42.0.0/sdk/notifications.md b/docs/pages/versions/v42.0.0/sdk/notifications.md
@@ -857,7 +857,7 @@ It returns a `Promise` resolving to a number representing current badge of the a
 
 ### `setBadgeCountAsync(badgeCount: number, options?: SetBadgeCountOptions): Promise<boolean>`
 
-Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge.
+Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge. On iOS, this method requires that you have requested the user's permission for `allowBadge` via [`requestPermissionsAsync`](#requestpermissionsasyncrequest-notificationpermissionsrequest-promisenotificationpermissionsstatus), otherwise it will automatically return `false`.
 
 > **Note:** Not all Android launchers support application badges. If the launcher does not support icon badges, the method will resolve to `false`.
 

diff --git a/docs/pages/versions/v43.0.0/sdk/notifications.md b/docs/pages/versions/v43.0.0/sdk/notifications.md
@@ -857,7 +857,7 @@ It returns a `Promise` resolving to a number representing current badge of the a
 
 ### `setBadgeCountAsync(badgeCount: number, options?: SetBadgeCountOptions): Promise<boolean>`
 
-Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge.
+Sets the badge of the app's icon to the specified number. Setting to `0` clears the badge. On iOS, this method requires that you have requested the user's permission for `allowBadge` via [`requestPermissionsAsync`](#requestpermissionsasyncrequest-notificationpermissionsrequest-promisenotificationpermissionsstatus), otherwise it will automatically return `false`.
 
 > **Note:** Not all Android launchers support application badges. If the launcher does not support icon badges, the method will resolve to `false`.