Notification

Supported platforms:
Available since: Gideros 2011.6

Description

Notification class is used to compose and schedule new local notifications. You need to provide an ID of notification to constructor. Using same provided ID you can create a new instance of Notification class and modify existing notification with that ID. Additionally the ID allows you to identify local notification in the table of scheduled local notifications retrieved from NotificationManager:getScheduledNotifications, or table of local notifications that were already displayed using NotificationManager:getLocalNotifications

Notification consists of notification message, title, sound and number. Only message is the mandatory one. You can combine others as you wish.

Examples

Create new notification and dispatch right away
<syntaxhighlight lang="lua">local note = Notification.new(1) note:setTitle("Notification app") note:setMessage("Do you see me?") note:setSound("./some_sound.wav") note:dispatchNow()</source> Create new notification and dispatch after one hour with repeating period of one day
<syntaxhighlight lang="lua">local note = Notification.new(2) note:setTitle("Notification app") note:setMessage("I will bother you each day") note:dispatchAfter({hour = 1}, {day = 1})</source> Create new notification and dispatch on specific date in specific time
<syntaxhighlight lang="lua">local note = Notification.new(3) note:setTitle("Notification app") note:setMessage("Happy Birthday") note:dispatchOn({year = 2013, month = 8, day = 1, hour = 9, min = 0, sec = 0})</source> Modifying existing scheduled notification
<syntaxhighlight lang="lua">--id of notification to modify local id = 1

--retrieve shared instance local mngr = NotificationManager.getSharedInstance()

--retrieve table with scheduled notifications local t = mngr:getScheduledNotifications()

--check if id is in it if t[id] then --notification is still scheduled --let's modify it by creating new instance with same id local note = Notification.new(id) note:setTitle("New title") note:setMessage("New message") --if we want to modify dispatch time we need to redispatch it note:dispatchAfter({day = 1}) end</source>

Methods Notification.new creates new notification Notification:cancel cancel notification Notification:dispatchAfter Dispatch notification after specified time Notification:dispatchNow dispatch notification now Notification:dispatchOn dispatch on specified date Notification:getId get id of notification Notification:getMessage get message of notification Notification:getNumber get notification number Notification:getSound get sound of notification Notification:getTitle get title of notification Notification:setNumber set notification number Notification:setSound set notification sound Notification:setTitle set the title of notification

Events Constants Notification.DEFAULT_SOUND