Notifications API library

Notifications API

The Notifications Client API allows applications on the device to register and receive notifications from the Notification Service. The Notifications API is supported by the Nokia Qt development environment, enabling developers to create engaging, sticky applications in a matter of hours, not days. The Notifications API makes it easy to add real-time push notifications to your client applications running on Nokia devices. See the Forum Nokia documentation about Notifications client API for more information.

Glossary

Term	Description
Application ID	A unique identifier for the application. The Application ID is the reverse of the Service ID; for example, if com.ovi.nnapi.ovireader is the Service ID, then ovireader.nnapi.ovi.com is the Application ID. See Notifications API wiki pages for more information how to request Application ID.
Application wake-up	Parameter specifying whether an application that is not already running on the device should be started when a notification is received.
JID	Identity of a Notifications user. The JID consists of a username and a domain; for example, "zacharias.topelius@ovi.com". The username is the same as the Nokia account name.
NID	See Notification ID
Notification ID	A client application identifier that a service can use to send notification to a specific application instance.
Notifications Enabler	Component running on the device and responsible for establishing an active connection to the Notification Service. A single Notifications Enabler can handle multiple client applications.
Payload	Notification content for the client. Maximum size is 1.5 kB. See OviNotificationPayload class definition for details.

Overview

You use the Client API in your client application to:

• Register your application to the Notifications Enabler. The Notifications Enabler is responsible for establishing an active connection to the Notifications Service. A single Notifications Enabler can handle multiple client applications.
• Retrieve the Notification ID. NID is needed for the service in order to send notifications to application.
• Receive the notifications.

Main classes

Class name	Brief Description
OviNotificationSession	Actual session with the Notifications Enabler.
OviNotificationMessage	Contains the information about received notifications
OviNotificationPayload	Content of the received notification.
OviNotificationState	Information about the state of the OviNotificationSession.
OviNotificationInfo	Contains the Notification ID.

Please see Forum Nokia site for more information https://projects.developer.nokia.com/notificationsapi/wiki

NOTE! Forum Nokia site focuses on Symbian and screenshots might differ

Getting started

• Setup in Harmattan
• Examples