Skip to content

readme.md

Latest commit

 

History

History
54 lines (45 loc) · 3.12 KB

readme.md

File metadata and controls

54 lines (45 loc) · 3.12 KB

overview

This is used by in app banner or toast notification in phcode. It is automatically translated by Google Translate. You just need to update <stage>/root/banner.json and <stage>/root/toast.json folder in english language and a pull request will be raised by GitHub actions translating it into all supported languages.

You should merge the pull request if release is valid update, and then merge the main branch into update-notifications branch to trigger the updates across the installation base.

banner notifications - banner.json

image

Banner notifications are shown at the bottom of brackets as seen in picture. Only use this in case of emergencies to push security updates or other critical updates that needs user attention. Atmost one banner notification will be shown at a time on screen. If there are multiple, the next notification will only be shown once the current notification is closed.

Format of <stage>/root/banner.json

<stage> can be staging or prod. (dev stage is directly in phoenix codebase for ease of development.)

A sample json is as follows:

{
  "SAMPLE_NOTIFICATION_NAME": {
    "DANGER_SHOW_ON_EVERY_BOOT" : false,
    "HTML_CONTENT": "<div>hello world <a class='notification_ack'>Click to acknowledge.</a></div>",
    "FOR_VERSIONS": "1.x || >=2.5.0 || 5.0.0 - 7.2.3", 
    "PLATFORM" : "allDesktop",
    "USER_TYPE" : ["paidSubscriber", "loggedIn"]
  },
  "ANOTHER_SAMPLE_NOTIFICATION_NAME": {...}
}

By default, a notification is shown only once except if DANGER_SHOW_ON_EVERY_BOOT is set or there is an html element with class notification_ack.

  1. SAMPLE_NOTIFICATION_NAME : This is a unique ID. It is used to check if the notification was shown to user.
  2. DANGER_SHOW_ON_EVERY_BOOT : (Default false) Setting this to true will cause the notification to be shown on every boot. This is bad ux and only be used if there is a critical security issue that we want the version not to be used.
  3. HTML_CONTENT: The actual html content to show to the user. It can have an optional notification_ack class. Setting this class in any child html node will cause the notification to be shown once a day until the user explicitly clicks on any html element with class notification_ack or explicitly click the close button. If such a class is not present, then the notification is shown only once ever.
  4. FOR_VERSIONS : Semver compatible version filter. The notification will be shown to all versions satisfying this.
  5. PLATFORM: A comma seperated list(no spaces) of all platforms in which the message will be shown. allowed values are: mac,win,linux,allDesktop,firefox,chrome,safari,allBrowser,all
  6. USER_TYPE: An array of all user types in which the message will be shown. allowed values are: [all, notLoggedIn, loggedIn, trial, paidSubscriber, notPaidsubscriber]. This filter is only available in versions > 5, else it is ignored in older versions. combine with FOR_VERSIONS to filter based on user type.