The Nokia Notifications Client API is available for Nokia Asha software platform devices. The Client API provides the following features:
Check and update the latest Notification Enabler
Register/unregister your MIDlet
Retrieve Notification ID
Nokia Notifications indicators and settings
It´s possible to keep Notification Enabler up-to-date so that it provides to the user an option to update the software. Users can update Notification Enabler by themselves or the update can be provided to user by including the Installer implementation as part of your Notification integration.
Figure 1. Checking and updating to the latest Notification Enabler
To be able to receive notifications, your MIDlet must register with the Notification Enabler. The Notification Enabler is responsible for establishing an active connection to the Notification Server. There may be times when a user does not want to receive notifications, for example, at a certain time of day or in a specific location. The Nokia Notifications Client API allows a MIDlet to unregister for notifications to prevent delivery.
The MIDlet has to request for a Notification ID, which specifies the recipient of a notification. It is used by the Notification Server to route notifications. Once the MIDlet has retrieved the Notification ID, it then shares this ID with its respective service, so the service knows where to send the notification.
Once a notification is received on a user’s device, it will be delivered to the appropriate MIDlet through the Nokia Notifications Client API. Delivery can occur regardless of the current state of the MIDlet: If your MIDlet is not running, notification banner is shown. Otherwise the notification is delivered directly to the MIDlet.
The Nokia Notifications Client API enables access to an always-on connection that is shared between all MIDlets on the device that use the API. An optimised connection means that additional MIDlets don’t generate additional radio traffic overhead. In poor network coverage, it is recommended to use Store and Forward functionality for future delivery of messages, by using expires-at parameter. Notifications work in most of the networks via mobile data connections and WiFi. However, notifications through WAP gateways are not supported.
a) Notification indicators
When a notification is received in the device:
A Notification banner appears as a banner on the top of the screen. It consists of the following elements:
The icon of the MIDlet that the notification was sent to. The icon is read from the MIDlet jad parameter MIDlet-Icon that is saved on the device when the MIDlet is installed.
The display name of the MIDlet that the notification was sent to. The display name is read from jad parameter MIDlet-Name value of the MIDlet.
The number of received notifications or a notification title. When a notification is sent, it is possible to include a title attribute in the notification. If the title attribute exists in the notification, the value of the title is shown. If the title attribute is not present, the number of received notifications is shown. The number of received notifications indicates the number of unread notifications that are waiting for the MIDlet to read them by using the Nokia Notifications Client API.
A Notification tone is played, if selected in the Notification tone under Settings, and if the attribute is set in the message when sending using the REST API.
A Notification tone is played if selected in the Notification tone under Settings, if the attribute is set in the message when sending using the REST API, and if the MIDlet has called setAudioAlertEnabled function (default value is false).
b) Notification panel
After the notification has been received and the banner is shown, the notification is moved to the notification panel. The item shows the MIDlet icon, the display name, the title of the latest received notification and time. If the MIDlet is using JSR-211 for Nokia Notifications then every received notification for that MIDlet is shown as single (ungrouped) item in the notification panel. Each MIDlet can have maximum 5 ungrouped notifications visible on the Notification Panel. If application is not using JSR-211, items are grouped.
c) Notification settings
The push notification related settings can be found under Background apps settings. Each MIDlet has a switch that can be enabled or disabled. When the application switch is enabled for the MIDlet, it can receive notifications in the device, and when the application switch is disabled for the MIDlet, it cannot receive notifications in the device.
If you are testing your Nokia Notifications MIDlet in the Sandbox environment, then you need to restart your emulator/device, after you enable or disable the application switch in the Background apps settings page.
Badging indicates new thing i.e. what has happened since the last time application was opened. This informs user that there are new notifications inside application.
e) Standby screen/Lock screen
User can open notifications also from lock screen. Grouping/ungrouping with JSR-211 is also valid in this view.
When Notification privacy is switched on, no preview is shown neither in standby screen or lock screen. Only notification icon is shown to indicate that new notifications have been received.
Last updated 5 March 2014