Skip to content

Commit 53ee271

Browse files
committed
chore: update notificatiojn docs
1 parent 2f4e5ab commit 53ee271

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/appNotifications/readme.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ A sample json is as follows:
2525
{
2626
"SAMPLE_NOTIFICATION_NAME": {
2727
"DANGER_SHOW_ON_EVERY_BOOT" : false,
28-
"PRO_EDITION_ONLY" : false,
2928
"HTML_CONTENT": "<div>hello world <a class='notification_ack'>Click to acknowledge.</a></div>",
3029
"FOR_VERSIONS": "1.x || >=2.5.0 || 5.0.0 - 7.2.3",
31-
"PLATFORM" : "allDesktop"
30+
"PLATFORM" : "allDesktop",
31+
"USER_TYPE" : "all"
3232
},
3333
"ANOTHER_SAMPLE_NOTIFICATION_NAME": {...}
3434
}
@@ -38,8 +38,6 @@ A sample json is as follows:
3838
or there is an html element with class `notification_ack`.
3939

4040
1. `SAMPLE_NOTIFICATION_NAME` : This is a unique ID. It is used to check if the notification was shown to user.
41-
2. `PRO_EDITION_ONLY` : (Default false) Setting this to true will not show the notification on community editions.
42-
Only works in versions > 5.0.0 - so combine it with that is must!
4341
2. `DANGER_SHOW_ON_EVERY_BOOT` : (Default false) Setting this to true will cause the
4442
notification to be shown on every boot. This is bad ux and only be used if there is a critical security issue
4543
that we want the version not to be used.
@@ -51,3 +49,6 @@ A sample json is as follows:
5149
The notification will be shown to all versions satisfying this.
5250
5. `PLATFORM`: A comma seperated list(no spaces) of all platforms in which the message will be shown.
5351
allowed values are: `mac,win,linux,allDesktop,firefox,chrome,safari,allBrowser,all`
52+
6. `USER_TYPE`: A comma seperated list(no spaces) of all user types in which the message will be shown.
53+
allowed values are: [`all`, `notLoggedIn`, `loggedIn`, `trial`, `paidSubscriber`]. This filter is only available
54+
in versions > 5, else it is ignored in older versions. combine with `FOR_VERSIONS` to filter based on user type.

0 commit comments

Comments
 (0)