NotifPushSend (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Mobile specific functions / Phone functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

NotifPushSend (Function)

In french: NotifPushEnvoie

Sends a push notification to a mobile device (iOS or Android). This function can be used in a WINDEV application or in a WEBDEV website.

Example

// Envoi d'une notification push sur iOS
TokensEnvoi is array of Buffers
MonMotDePasse is string ANSI = "Password"
FOR i = 1 TO nbTokens
	Add(TokensEnvoi, tokens[i])
END 
MaNotification is Notification
MaNotification.Message = "Nouvelle notification"
MonRésultat is boolean 
MonRésultat = NotifPushSend(MaNotification, TokensEnvoi, "certifapple.cer", MonMotDePasse, NomBundleID, typeServiceIOSRelease)
IF MonRésultat = False THEN
	Trace(ErrorInfo())
END

Syntax

iPhone/iPad: Send a notification Hide the details

<Result> = NotifPushSend(<Notification> , <Tokens> , <Identification> , <Password> , <TopicID> , <Server type>)

<Result>: Boolean

True if the sending was successful,
False otherwise. ErrorInfo is used to identify the error returned by the notification service.

<Notification>: Notification

Name of the Notification variable corresponding to the notification to send.

<Tokens>: Array of buffers

Name of the array variable containing the list of tokens representing the devices on which the notification is to be sent.

<Identification>: Character string

Full path of the file containing the certificate for the application push notifications (obtained from Apple). For more details, see Conditions required for the Push notifications in iOS.

<Password>: ANSI string or Secret string

Password of the file containing the certificate for Push notifications. If the file does not have a password, use an empty string (""). This parameter must correspond to an ANSI character string.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI string - Latin".
To learn more about secret strings and how to use the vault, see Secret string vault.

<TopicID>: Character string

Bundle identifier specified in the "General" section of the Xcode project generation wizard.

<Server type>: Integer constant

Type of server onto which the notification will be sent:
typeServiceIOSRelease Server of IOS release (APN).
typeServiceIOSTest Server of IOS test (APN).

Android: Send a notification Hide the details

<Result> = NotifPushSend(<Notification> , <Tokens> , <Identification> , <Invalid tokens> [, <Platform>])

<Result>: Boolean

True if the sending was successful,
False otherwise. ErrorInfo is used to identify the error returned by the notification service. These errors can contain a list of invalid tokens that must be deleted from the token database.

<Notification>: Notification

Name of the Notification variable corresponding to the notification to send.

<Tokens>: Array of buffers

Name of the Array variable containing the list of tokens representing the devices to which the notification will be sent.

<Identification>: Character string

Application ID parameter:
on the Firebase platform, with the Firebase Cloud Messaging V1 API: content of the JSON file corresponding to the service account's private key.
A specific configuration is required to get this JSON file. For more details, see Configuration required for Push notifications in Android.
on the Firebase platform, using the Cloud Messaging API: Google authorization key.
A specific configuration is required to get this key. For more details, see Configuration required for Push notifications in Android.
on GCM service (retained for compatibility): Google authorization key.
A specific configuration is required to get this key. For more details, see Push notification: Android configuration (Google Cloud Messaging)

<Invalid tokens>: Array of buffers

Name of the Array of Buffers variable. This parameter is filled with the list of invalid tokens returned by the server.

<Platform>: Optional Integer constant

Platform that will be used to send the notification. The Android application that will receive he notifications must have been configured for this type of platform.
npeFirebase Firebase platform using the Cloud Messaging API.
Push notification platform available in WINDEV 22 Update 1. This platform is available:
for existing Firebase projects that already use this solution.
for new Firebase projects, if this API is enabled.
npeFirebaseCM_v1 Firebase platform using the Firebase Cloud Messaging API (V1).
New push notification platform enabled by default for new Firebase projects.
Starting with WINDEV 28 Update 2, this platform must be used for projects using the Firebase Cloud Messaging API (V1).
npeGCM
(Default value) Google Cloud Messaging platform.
Former Google solution for sending push notifications.
This platform should only be used for existing projects already using push notifications (projects created with versions earlier than WINDEV 22 Update 1)

Remarks

The push notification is sent to a notification service (Apple or Google) that redistributes this notification to a set of mobile devices.
The supported services are:
- Google Firebase (Google GCM is supported for backward compatibility. Firebase is recommended by Google).
  - Firebase Cloud Messaging API (V1)
  - Cloud Messaging API
- Apple APN.
The notifications sent to the Android devices take into account the proxy defined by Proxy.
Starting with Android 8, notifications sent to Android devices take into account the notification category (also called "Channel").
iOS features:
- The notifications sent to the devices running iOS are direct (they do not transit via the proxy).
- The Apple service allows 256 bytes of data per notification only. Therefore, pay attention to the amount of data sent in the Notification variable (the message for example) to avoid exceeding this limit. An error will occur if the limit is exceeded.
- The connection to the APN server may fail if two notifications are sent in a very short time interval (if the server is still processing the first message).
- To send push notifications on the iOS devices, the application must be able to access the ports 2195 and 2196 in TCP.
HTTPS request handling mode:
HTTPS exchanges with notification services use the request management mode (cf. function HTTPConfigure):
- in progress in the Android application,
- cross-platform for iOS.
Before calling the function NotifPushSendfunction, it may be necessary to modify the request management mode with function HTTPConfigure in order to adapt it to the configuration, particularly when a proxy is required.

Related Examples:

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.

Cross-platform examples: Send Push

[ + ] This example allows you to send push notifications to Android and iOS devices.
It retrieves the identifiers of the mobile devices in the HFSQL database of the "WD Push Server" example, then sends the notifications via the NotifPushSend function.

Component: wd300device.dll