notificationCategory (Variable type)

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

Properties specific to notificationCategory variables
Functions that use the notificationCategory type
Reinitialization

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Notification (Variable type)

notificationCategory (Variable type)

In french: notificationCatégorie

The type notificationCategory makes it possible to define all the advanced characteristics of a notification category. The notifications of the application can be associated with a notification category. You can define and change the characteristics of this notification category using different WLanguage properties.

This type of variable is used by Notification variables.

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

Example

// Description de la catégorie de notification à utiliser
catégorieNotif is notificationCategory
catégorieNotif.Identifier = "ID_NOTIF_COM"
catégorieNotif.Name = "Notifications commerciales"
catégorieNotif.Priority = notifHighPriority

// Ajout d'une notification associée à la catégorie
n is Notification
n.Title = "Nouveau message"
n.Message = "Commande n°54781-4551"
n.SecondaryMessage = "client@societe.com"
n.Category = catégorieNotif
NotifAdd(n)

Properties

Properties specific to notificationCategory variables

The following properties can be used to handle a notification category:

Property name	Type used	Effect

BadgeEnabled	Boolean	True (default value) if the notifications of the category should be taken into account to display the application badge. False otherwise.
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 LED color changes or only offer certain colors.. A default color will be used if the specified color is not supported by the device.
Description	Character string	Description of the notification category (optional).
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.
Identifier	Character string	Identifier of the category. This property must not be empty. This identifier is unique for the application (case and accent-sensitive).
Name	Character string	Name of the category. This name must not be empty.
Priority	Integer	Priority of notifications associated with the category. The priority of a notification has an influence on how the notification is shown to the user. 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: notifPriorityMax maximum priority (example: incoming call). highprioritynotification High priority (e.g. receipt of an urgent Email). notifPriorityDefault (default value): normal priority (example: receiving an SMS). notifPriorityLow Low priority (e.g. update notification). notifPriorityMin minimum priority (example: commercial information).
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. It is possible to play a sound from an audio file integrated into the application (via the generation wizard): simply enter the file name and extension. To associate no sound with the notification, use an empty string ("", default value).
Vibration	Boolean	True if the device must vibrate when displaying the notification, False (default value) otherwise. Note: Vibration duration and strength may vary from one device to another.
VisibleOnLockScreen	Boolean	True if the notification must be visible in the lock screen, False (default value) otherwise.

Remarks

Functions that use the notificationCategory type

The following functions manage notificationCategory variables:


NotifDeleteCategory	Deletes a notification category from the application.
NotifListCategory	Lists the notification categories of the application.

Reinitialization

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