|
|
|
|
|
|
|
|
- Using the Notification type
- Example of notification in Android
- Properties specific to Notification variables for a push notification
- Functions that use the Notification type
- Reinitialization
Notification (Variable type)
The Notification type is used to handle 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.
notif is Notification
notif.Title = "Nouveau message reçu"
notif.Message = "Cliquez pour afficher le message"
NotifAdd(notif)
Observaciones Using the Notification type The Notification type is used to manage the local notifications and the push notifications. This help page presents: Example of notification in Android The different elements of this notification can be configured by the Notification type: - 1. Large notification icon (LargeIcon property).
- 2. Notification title (Title property).
- 3. Notification message (Message property).
- 4. Secondary message (SecondaryMessage property).
- 5. Time for receiving the notification (Chronometer property).
- 6. Application icon (Icon property).
- 7. Additional actions of the notification (AdditionalAction property).
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. | | ActivateApplication | Boolean | - True if the application must be displayed in the foreground during the click on the notification.
- False (default value) otherwise.
| | Badge | Integer | Number displayed by the icon of the application. | | 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.
| | 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.
| | 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.
- Calling the NotifDelete function .
- If the WLanguage procedure run on the click (ActionClick property) returned True or returned no value.
| | 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. | | 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). | | 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. | | 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. | | 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. | | 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.
| | 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. | | 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. | | 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). | | 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. | | 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. |
Functions that use the Notification type The following functions handle the Notification variables for a local notification:
| | | NotifAdd | Agrega una notificación a la barra del sistema (Android) o al centro de notificaciones (iOS). | | NotifDelete | Elimina una notificación de la barra del sistema. | | NotifModify | Modifica una notificación que se muestra actualmente en la barra del sistema del dispositivo. | | NotifPushSend | Envía una notificación push a un dispositivo móvil (iOS o Android). | | ThreadPersistent | Hace que un Thread sea persistente. |
Reinitialization You can use VariableReset to reset the content of a Notification variable.
Esta página también está disponible para…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|