Local Notification Configuration Data Structure

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*.

Proposed Design

We're proposing the data structure for configuring the local notification.

Solution 1:

A notification will be triggered on every Tuesday at 7:30 PM (19:30) from the next coming Tuesday onwards.

And will be repeated 4 time only, after which there won't be any notification.

[
  {
     time: "19:30",
     day: "Tuesday",
	 repeat: 7
     occurrence: 4,
     title: "{\"en\":\"Message\"}",
     msg: "{\"en\":\"Description for Notification\"}"
  }
]

Solution 2:

A)

A notification will be triggered on every month 20th at 7:00 PM (19:00) from the next coming date.

And will be repeated monthly, till the given date in `endRepeat` i.e 20 May 2019 

{
  time: "19:00",
  date: 20,
  repeat: "monthly",
  endRepeat: {
    date: "20/05/2019"
  }
  title: "{\"en\":\"Message\"}",
  msg: "{\"en\":\"Description for Notification\"}"
}

B)

A notification will be triggered on every day at an interval of 5 days at 10:00 AM (10:00).

And will be occurring for next 6 weeks, after which notification will stop.

{
  time: "10:00",
  interval: 5,
  endRepeat: {
    weeks: 6
  }
  title: "{\"en\":\"Message\"}",
  msg: "{\"en\":\"Description for Notification\"}"
}

For repeat object:

Pros and Cons

Using In App Notification Payload

After the discussion, we'll be using the same payload structure as described in In App Notification.

{
"id": 14, // id of the notification will be integer, which will be unique
"type": 1, // Notification type will be integer - Their can different notification types, like DOWNTIME, GREETINGS, NON-DISPLAY and OTHERS
"data":{ // action data contains all the information related to type of the notification, start, msg, notification title
	start: '2019/05/20 19:00' // first triggered on specified date, and onwards weekly
	interval: 'week'
	translations: {
		"en": {
			"title": "Title text",
			"msg": "Descriptive message"
		},
		"default" : { // any default language, if language translation not available then to be used
			"title": "Title text",
			"msg": "Descriptive message"
		}
	}
}
}

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