Notification (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Using the Notification type
Properties specific to Notification variables for a local notification
Properties specific to Notification variables for a push notification
Functions that use the Notification type
Reinitialization

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Notification (Variable type)

In french: Notification

The Notification type is used to handle

the local notifications.
the push notifications.

You can define and change the characteristics of this notification using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Simple notification
// --------------------
notif is Notification
notif.Title = "New incoming message"
notif.Message = "Click here to display the message"
NotifAdd(notif)

// Notification with two additional actions
n is Notification
n.Title = "New message"
n.Message = "Order #54781-4551"
n.SecondaryMessage = "customer@company.com"
n.LargeIcon = "envelope.png"
n.AdditionalAction[1].ActionLabel = "Respond"
n.AdditionalAction[1].Icon = "respond.png"
n.AdditionalAction[1].ActionClick = "procRespond"
n.AdditionalAction[2].ActionLabel = "Delete"
n.AdditionalAction[2].Icon = "delete.png"
n.AdditionalAction[2].ActionClick = "procDelete"
NotifAdd(n)

// Notification while defining a notification format
n is Notification
n.Title = "Photo saved"
n.Message = "Date taken: 18/07/2014 19:45"
n.LargeIcon = "photo.png"
n.SecondaryMessage = "desert.png"
n.Format.Format  = notifImageFormat
n.Format.Content = fCurrentDir + "photos/desert.png"
NotifAdd(n)

Remarks

Using the Notification type

The Notification type is used to manage the local notifications and the push notifications.

This help page presents:

the properties specific to the description of Notification variables for a local notification.
the properties specific to the description of Notification variables for a push notification.

Properties specific to Notification variables for a local notification

The following properties can be used to handle a notification:

Property name	Type used	Effect

ActionClick	Value or name of procedure	Name of WLanguage procedure called when the user clicks the notification in the drop-down list of notifications displayed on the device. This procedure has the following format: PROCEDURE <Procedure name> (<Notification>) where <Notification> is a Notification variable corresponding to the notification selected by the user. If the WLanguage procedure returns True or if it returns no value: the notification will be automatically deleted from the system bar. the notification is not deleted from the system bar. If the procedure returns False, the notification will still be displayed. If the ActionClick property is set to an empty string (""), there will be no on-click action and the notification will be automatically deleted afterwards. It is recommended to use global procedures. If the procedure is a local procedure, the name of this procedure must be prefixed by the full name of object to which the procedure belongs. For example, for a procedure local to a window: "WIN_Window1.MyProcedure".
ActionLabel	Character string	Caption for the action button of the notification. This property is not available.
ActivateApplication	Boolean	True if the application must be displayed in the foreground during the click on the notification. False (default value) otherwise. This property is not available.
ActivationDateTime	DateTime or character string	Date and time when the notification must be sent. The notification is sent immediately be default. This property is not available.
AdditionalAction	Array of notificationAction variables	Additional actions associated with the notification. Caution: The additional actions of notifications are available from Android 4.1 (Jelly Bean, api level 16). The additional actions will be ignored on the devices running an earlier version. This property is not available.
AlertOnce	Boolean	Allows managing the alert in case the notification is already displayed: True to not play the notification sound or vibration if the notification is already displayed, False (default value) otherwise. This property is not available.
Badge	Integer	Number displayed by the icon of the application. On Android, this property is supported from version 8.0.
Category	notificationCategory	Category associated with the notification. Notification categories are available from Android 8.0 (API level 26). If the application runs on an older version, the Category property will be ignored. It is recommended to always associate a category with a notification If the category does not exist when the notification is added, it will be automatically created, If the category already exists for the application, the notification will be associated with it. If no category has been specified, the notification will be automatically associated to a preset category according to its level of priority. These are the preset categories: Min. priority Low priority Standard priority High priority Max. priority The preset category will be created when adding a notification without category for the first time with the corresponding level of priority, and it will use the visual and audio parameters of this notification (vibration, sound, led indicator, etc.). These parameters can later be modified by the end user. If the predefined category already exists, the notification will inherit its properties. This property is not available.
ColorLED	Integer	Color of LED when displaying the notification. The value of this property is taken into account only if DisplayLED is set to True. The display color of the LED is green by default. This color can correspond to: an RGB color (returned by RGB), an HSL component of the color (returned by HSL), a WLanguage preset color. Caution: Some devices do not allow you to modify the LED color or they do not propose all the colors. A default color will be used if the specified color is not supported by the device. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
Content	Character string	Custom data of notification. This data is not displayed in the notification.
Deletable	Boolean	True (default value) if the notification can be deleted by the user, False otherwise. If this property is set to False, the notification will be erased in the following cases: The application is closed. The NotifDelete function is called. If the WLanguage procedure run on the click (ActionClick property) returned True or returned no value. This property is not available.
DisplayLED	Boolean	True if the LED of the device must be switched on when the notification is displayed, False (default value) otherwise. The color of the LED and the frequency of lighting can change from a device to another one. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
DropDownText	Character string	Drop-down text briefly displayed in the system bar when displaying the notification. No message will be displayed if this property corresponds to an empty string ("", default value). This property is not available.
Format	notificationFormat	Display format of the notification when this one is expanded. Caution: Displaying the notifications in "expanded" mode is available from Android 4.1 (Jelly Bean, api level 16). The display format will be ignored on the devices running an earlier version. This property is not available.
Icon	Character string	Path of the image corresponding to the icon associated with the notification. The icon of the application will be used if no icon is specified. Remarks: The file used must be found in bundle de of the application. The specified path must be a relative path. The image will be displayed only if the application is not in the foreground (which means if the application is not enabled).
LargeIcon	Character string	Path of image corresponding to the large icon associated with the notification. This icon will be displayed to the left of the notification title and message. If no image is specified, the icon specified by the Icon property will be used. If this one is not specified, the icon of the application will be used. Caution: Displaying this image in the notifications is available from Android 3.0 (Honeycomb, api level 11). This image will be ignored on the devices running an earlier version. This property is not available.
Local	Boolean	True if the notification is local to the device that receives it: this notification must not be transmitted to the objects operating in Android Wear connected to the device (a watch for example). False (default value) if the notification must be automatically transmitted to the connected objects. This property is not available.
Message	Character string	Message of the notification.
Priority	Integer constant	Priority of notification. Changing the priority of a notification is used to modify its display position in the list of notifications on the device in order for the user to see the most important notifications first. A notification with a high priority will be displayed at the top of the list while a notification with a low priority will be displayed at the end of the list. In some situations, a notification with a low priority can be hidden to the user if other notifications with higher priorities are received. This property can take the following values: notifMaxPriority: maximum priority (example: incoming call). notifHighPriority: high priority (example: receiving an urgent email). notifDefaultPriority (default value): standard priority (example: receiving an SMS). notifLowPriority: low priority (example: notification for update). notifMinPriority: minimum priority (example: commercial information). Modifying the priorities of notifications is available from Android 4.1 (Jelly Bean, api level 16). The priority will be ignored on the devices running an earlier version: all the notifications have the same priority. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
ProgressBarMax	Integer	Maximum value of the progress bar displayed in the notification. The value will be taken into account only if the ProgressBarType property corresponds to the notifStandardProgressBar constant. This feature is available from Android 3.0. This property is not available.
ProgressBarType	Integer constant	Type of progress bar displayed in the notification: notifInfiniteProgressBar: an infinite progress bar will be displayed in the notification. notifNoProgressBar (default value): no progress bar will be displayed in the notification. notifStandardProgressBar: a standard progress bar will be displayed in the notification. The value and the bound of this progress bar can be defined by .ProgressBarMax and .ProgressBarValue respectively. This feature is available from Android 3.0. This property is not available.
ProgressBarValue	Integer	Current value of the progress bar displayed in the notification. The value will be taken into account only if the ProgressBarType property corresponds to the notifStandardProgressBar constant. This feature is available from Android 3.0. This property is not available.
SecondaryMessage	Character string	Secondary message displayed below the main message of the notification. Caution: Displaying a secondary message in the notifications is available from Android 4.1 (Jelly Bean, api level 16). The secondary message will be ignored on the devices running an earlier version. This property is not available.
Sound	Character string	Path of the sound file to play when displaying the notification. To play the default sound of notifications, use the notifDefaultSound constant. This default sound can change from a device to another one. You have the ability to play a sound issued from an audio file included in the application (via the generation wizard): to do so, specify the name of the file and its extension. To associate no sound with the notification, use an empty string ("", default value). Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. Remarks: The file used must be found in bundle de of the application. The specified path must be a relative path. The file used must be in "aac" format and its duration must not exceed 30 seconds. The sound will be played only if the application is not in the foreground (which means if the application is not enabled).
Stopwatch	Boolean	True to display a stopwatch instead of the notification time. The stopwatch will be automatically started when receiving the notification and its display will be automatically refreshed. False (default) to avoid displaying a stopwatch. The time associated with the notification will be displayed. Caution: Displaying a stopwatch in the notifications is available from Android 4.1 (Jelly Bean, api level 16). On the devices running an earlier version, the stopwatch will be ignored and the time associated with the notification will be displayed. This property is not available.
Title	Character string	Notification title. The name of the application will be used if no title is specified.
Vibration	Boolean	True if the device must vibrate when displaying the notification, False (default value) otherwise. Remark: The duration and the power of vibrations can change from a device to another one. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.

Properties specific to Notification variables for a push notification

The following properties can be used to handle a notification:

Property name	Type used	Effect

ActionLabel	Character string	Caption for the action button of the notification. This property is not available.
ActivateApplication	Boolean	True if the application must be displayed in the foreground during the click on the notification. False (default value) otherwise. This property is not available.
Badge	Integer	Number displayed by the icon of the application. On Android, this property is supported from version 8.0.
Category	notificationCategory	Category associated with the notification. Notification categories are available from Android 8.0 (API level 26). If the application runs on an older version, the Category property will be ignored. It is recommended to always associate a category with a notification If the category does not exist when the notification is added, it will be automatically created, If the category already exists for the application, the notification will be associated with it. If no category has been specified, the notification will be automatically associated to a preset category according to its level of priority. These are the preset categories: Min. priority Low priority Standard priority High priority Max. priority The preset category will be created when adding a notification without category for the first time with the corresponding level of priority, and it will use the visual and audio parameters of this notification (vibration, sound, led indicator, etc.). These parameters can later be modified by the end user. If the predefined category already exists, the notification will inherit its properties. This property is not available.
ColorLED	Integer	Color of LED when displaying the notification. The value of this property is taken into account only if DisplayLED is set to True. The display color of the LED is green by default. This color can correspond to: an RGB color (returned by RGB), an HSL component of the color (returned by HSL), a WLanguage preset color.Caution: Some devices do not allow you to modify the LED color or they do not propose all the colors. A default color will be used if the specified color is not supported by the device. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
Content	Character string	Custom data of notification. This data is not displayed in the notification.
Deletable	Boolean	True (default value) if the notification can be deleted by the user, False otherwise. If this property is set to False, the notification will be erased in the following cases: The application is closed. The NotifDelete function is called. If the WLanguage procedure run on the click (ActionClick property) returned True or returned no value. This property is not available.
DisplayLED	Boolean	True if the LED of the device must be switched on when the notification is displayed, False (default value) otherwise. The color of the LED and the frequency of lighting can change from a device to another one. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
DropDownText	Character string	Drop-down text briefly displayed in the system bar when displaying the notification. No message will be displayed if this property corresponds to an empty string ("", default value). This property is not available.
Format	notificationFormat	Display format of the notification when this one is expanded. Caution: Displaying the notifications in "expanded" mode is available from Android 4.1 (Jelly Bean, api level 16). The display format will be ignored on the devices running an earlier version. This property is not available.
Group	Character string	Name of the group to which the push notification is associated. If several push notifications belonging to the same group are sent with an identical content while the destination device cannot be reached, only the last notification of the group will be sent when the device can be contacted again by the Google Cloud Messaging server. This property is not available.
Icon	Character string	Path of the image corresponding to the icon associated with the notification. The icon of the application will be used if no icon is specified.
LargeIcon	Character string	Path of image corresponding to the large icon associated with the notification. This icon will be displayed to the left of the notification title and message. If no image is specified, the icon specified by the Icon property will be used. If this one is not specified, the icon of the application will be used. Caution: Displaying this image in the notifications is available for the devices running Android 3.0 (Honeycomb, api level 11) or later. This image will be ignored on the devices running an earlier version. This property is not available.
Local	Boolean	True if the notification is local to the device that receives it: this notification must not be transmitted to the objects operating in Android Wear connected to the device (a watch for example). False (default value) if the notification must be automatically transmitted to the connected objects. This property is not available.
Message	Character string	Message of the notification.
Priority	Integer constant	Priority of notification. Changing the priority of a notification is used to modify its display position in the list of notifications on the device in order for the user to see the most important notifications first. A notification with a high priority will be displayed at the top of the list while a notification with a low priority will be displayed at the end of the list. In some situations, a notification with a low priority can be hidden to the user if other notifications with higher priorities are received. This property can take the following values : notifMaxPriority: maximum priority (example: incoming call). notifHighPriority: high priority (example: receiving an urgent email). notifDefaultPriority (default value): standard priority (example : receiving an SMS). notifLowPriority: low priority (example : notification for update). notifMinPriority: minimum priority (example : commercial information). Modifying the priorities of notifications is available from Android 4.1 (Jelly Bean, api level 16). The priority will be ignored on the devices running an earlier version: all the notifications have the same priority. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.
SecondaryMessage	Character string	Secondary message displayed below the main message of the notification. Caution: Displaying a secondary message in the notifications is available from Android 4.1 (Jelly Bean, api level 16). The secondary message will be ignored on the devices running an earlier version. This property is not available.
Sound	Character string	Path of the sound file to play when displaying the notification. To play the default sound of notifications, use the notifDefaultSound constant. This default sound can change from a device to another one. You have the ability to play a sound issued from an audio file included in the application (via the generation wizard): to do so, specify the name of the file and its extension. To associate no sound with the notification, use an empty string ("", default value). Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one.
Stopwatch	Boolean	True to display a stopwatch instead of the notification time. The stopwatch will be automatically started when receiving the notification and its display will be automatically refreshed. False (default) to avoid displaying a stopwatch. The time associated with the notification will be displayed. Caution: Displaying a stopwatch in the notifications is available from Android 4.1 (Jelly Bean, api level 16). On the devices running an earlier version, the stopwatch will be ignored and the time associated with the notification will be displayed. This property is not available.
Title	Character string	Notification title. The name of the application will be used if no title is specified. This property is not available.
Vibration	Boolean	True if the device must vibrate when displaying the notification, False (default value) otherwise. Remark: The duration and the power of vibrations can change from a device to another one. Management of notification categories (from Android 8.0): If a category was specified when the notification was added (Category property), this property is ignored. The notification will use the corresponding property of the category it is associated with. If no category was specified when the notification was added (Category property), the notification will be associated to the preset category corresponding to the value of the Priority property. If the preset category exists, this property is ignored: the notification will use the corresponding property of the preset category it is associated with. If the preset category does not exist yet, this property is used to define the properties to create one. This property is not available.

Functions that use the Notification type

The following functions handle the Notification variables for a local notification:


NotifAdd	Adds a notification to the system bar (Android) or notification center (iOS).
NotifDelete	Removes a notification from the system bar.
NotifModify	Modifies a notification currently displayed in the system bar of the device.
NotifPushSend	Sends a push notification to a mobile device (iOS or Android).
ThreadPersistent	Makes a thread persistent.

Reinitialization

You can use VariableReset to reset the content of a Notification variable.

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.

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.

Cross-platform examples (WINDEV Mobile): WM System

[ + ] This application is an example of some of the features of WINDEV Mobile available for Android/iOS.
The following system functions are used:
- NFC
- Multimedia control
- Brightness
- Volume
- Wi-Fi
- Bluetooth
- Toast
- Compass
- Accelerometer
- Camera control
- LED
- Vibration
- Notifications
- Drawing functions
- Internet