Skip to content

Commit 8746fca

Browse files
authored
Added documentation for new areNotificationsEnabled function. (#181)
* getSelection documentation added * fixed textbox docs I've added this before accidentally, it's only available for textField, not textBox. * fix * added getSelection doc to textBox * formating fix * fix * Added documentation to new areNotificationsEnabled function. * clean
1 parent 7d8d4b9 commit 8746fca

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# notifications.areNotificationsEnabled()
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [Function][api.type.Function]
5+
> __Return value__ none
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ notification, notifications, areNotificationsEnabled
8+
> __See also__ [notifications.*][plugin.notifications-v2]
9+
> --------------------- ------------------------------------------------------------------------------------------
10+
11+
12+
## Overview
13+
14+
Checks whether push notifications are enabled for the app on the device. Works for iOS and Android.
15+
Returns true if notifications are enabled, false otherwise.
16+
17+
## Syntax
18+
19+
notifications.areNotificationsEnabled()
20+
21+
## Example
22+
23+
``````lua
24+
local notifications = require( "plugin.notifications.v2" )
25+
26+
local enabled = notifications.areNotificationsEnabled()
27+
``````

markdown/plugin/notifications-v2/index.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ To use Firebase notifications on iOS make sure to include `plugin.notifications.
5050

5151
#### [notifications.registerForPushNotifications()][plugin.notifications-v2.registerForPushNotifications]
5252

53+
#### [notifications.areNotificationsEnabled()][plugin.notifications-v2.areNotificationsEnabled]
54+
5355

5456
## Project Settings
5557

0 commit comments

Comments
 (0)