Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Local notification purpose is to notify users to sue the mobile app for better learning experience.
Here user will get notification on timely basis, and the notification will be purely locally generated. For this, when the user installs the application and run it for the first time,  based on certain  configurations a notification event will be set on a particular date* and time*, which will be triggered at specified time with some message*.

...

PropertytypeValue (Example)Description
idint
id of the notification will be integer, which will be unique
typeenum
Notification type will be integer - Their can different notification types, like DOWNTIME, GREETINGS, NON-DISPLAY and OTHERS
dataobjtranslationsObject specifying the language, Example en
objinterval

Interval specifies the time interval difference between 2 notification. Example, for weekly once

value should be 7.

on a specific weekday

Ex: "interval": "weekday"  should go with 2 format of start

objstart

Date and time from when the notification will be triggered for the first time.  

  1. Format "2019/05/14 12:00"
or
  1. "4 19:00" [days 1-7, i.e Monday(1), ... Sunday(7)]
objoccurrenceNumber of times the notification should be triggered, if null then notification will be shown infinite times on the specified date and time or weekday

Translations object contains object with these properties with key specifying language code

PropertytypeValue (Example)Description
enobjtitleTitle of notification, should be string

objmsgDescription of notification, should be string
hiobjtitleTitle of notification, should be string

objmsgDescription of notification, should be string
defaultobjtitleTitle in any default language

objmsgMessage in any default language