Push notification

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Specific Mobile functions

Phone management functions

Push notification

Overview

Principle

Managing the notifications in the Mobile application

Managing the notifications in the application server

Related examples

See also

Push notification

Overview

A mobile device can receive push notifications. A notification is a message that is displayed (and stored) on the device, in the notification center of device. A notification can be used to start a process for example.

A notification is sent from a remote application, usually found on a server.

The application for sending notifications can be developed in WINDEV or WEBDEV, or via external tools.

Principle

Four elements are required to create a push notification system:

A mobile application (iOS or Android) run on the appropriate device.
A notification service that is used to distribute the push messages to the phones or tablets. This service is supplied:
- by Google: Firebase
  Remark: the application created before version 22 are using the Google Cloud Messaging mechanism (GCM). This mechanism will be made obsolete by Google from April 2019.
- by Apple (APM).
An application server (or provider) that decides to send the messages and that establishes the communication with the business database (this server can be a webservice or a WEBDEV or WINDEV application).
A database, used to store the identifiers of the different devices receiving the push messages as well as business data.

The global operating mode of push messages is as follows :

The application registers toward the Apple or Google service by using the "device id" and the "application id".
If the registration is successful, the Apple or Google service returns a token (or "registration id") to the application.
The application transmits the token to the application server (provider).
The server stores the token in its database.

A push message is send according to the following method:
a. The application server sends a message (by using an SSL socket (iOS) or an HTTPS socket (Android)) containing the token to the Apple or Google service.
Remark: this sending can be done by an external application, as long as this one can access the business database and the certificate used for the communication with the notification service.
b. The Apple or Google service transmits the message to the relevant device.

Managing the notifications in the Mobile application

Several functions can be used to manage the notifications in the Mobile application:


Versions 19 and later NotifPushDisable New in version 19 NotifPushDisable NotifPushDisable	Disables the management of push notifications for a WINDEV Mobile application (Android or IOS).
Versions 19 and later NotifPushEnable New in version 19 NotifPushEnable NotifPushEnable	Enables the management of push notifications in a WINDEV Mobile application (Android or iOS).
Versions 19 and later NotifPushProcedure New in version 19 NotifPushProcedure NotifPushProcedure	Specifies the WLanguage procedure called when a push notification is received by a WINDEV Mobile application (Android or iOS).

Caution: a specific configuration is required in order for the mobile applications to operate:

A specific configuration must be performed via the Firebase console. For more details, see Android configuration (Firebase).
A specific configuration must be performed. For more details, see iOS configuration.

The behavior when a notification is received is as follows:

If the application is closed, the system displays the notification in the notification bar. The user can choose to validate the notification. If he does, the application is started.
If no message is specified in the notification, the application is started and the notification is not displayed.
Two cases may occur once the application is started:
- If NotifPushProcedure was called in the project initialization code, the global procedure passed to this function as parameter is called and the first window of the application is not opened.
  Remark: OpenMobileWindow must be called in the procedure.
- If NotifPushProcedure was not called, the first application window is opened.
If the application is already started:
- If a message or a title is specified in the notification, the system displays the notification in the notification bar. If the user clicks the notification, the procedure specified in NotifPushProcedure is called (nothing happens if it is not specified).
  If no message and no title is specified in the notification, the notification is not displayed and the procedure is called directly.
- Two cases may occur:
  - If the application is in the foreground, the procedure of NotifPushProcedure is called directly. If no procedure is specified, only an "ok" button is displayed.
  - If the application is in the background, the system displays the notification. If the user validates the notification, the application returns to the foreground and the procedure of NotifPushProcedure is called.

Remarks:

The exeLaunch constant of ExeInfo allows you to know if the application was automatically started by the system further to the reception of a push notification:

ExeInfo(exeLaunch) = exePushNotification
WinStatus allows you to test (if necessary ) the existence of a window in order to open it:

// Summary: Procedure called when clicking on a PUSH notification
PROCÉDURE onPush(MyNotif is Notification)

IF WinStatus("WIN_Main") = NotFound THEN
// WIN_Main is already open or displayed
ReceivePushNotif(MyNotif, True)
ELSE
// Open home window
OpenMobileWindow(WIN_Main, MyNotif)
END

Managing the notifications in the application server

The application server is the WINDEV application or the WEBDEV site that sends the Push notifications.

This application server sends the notifications via NotifPushSend.

Caution: NotifPushSend must know the identifiers (tokens) of the phones affected by the notification. This information must be returned by the mobile application.

WINDEV Mobile is supplied with:

an example to manage the sending of Push notifications in Android and iOS.
a WINDEV example used to send notifications onto Android or iOS mobile devices.
a WINDEV example corresponding to the Webservice used to manage the dialog and the retrieval of identifiers.

Related Examples:

Cross-platform examples: WM Push

[ + ] This example shows how to receive Push notifications.
It calls the PushNotifActive function and returns the identifier to "WD Push Server", which stores it.
Then, the "Send Push" example reads this identifier and sends Push notifications to this example.

Cross-platform examples: WD_Push_Server

[ + ] This example is a webservice used to store the identifiers required to sent Push notifications to mobile devices.
The "WM Push" application stores the Push identifiers in the database of this example.
The "WD Send Push" example then reads these identifiers in order to send the notifications.