Availability
This routine is available starting with
- Power Scripts™ 2.5 (server)
- SIL ENgine™ (former katl-commons) 2.5
Syntax
lfGlobalMessage(message, messageClass);
Description
Displays a global message.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| message | String | Yes | Message to display |
| messageClass | String | Yes | Message type |
The messageClass parameter can be:
- ERROR: will display an error message
- WARNING: will display a warning message
- SUCCESS: will display a success message
- INFO: will display an info message
- HINT: will display a hint message.
Example
Use the following code to display a global error message.
lfGlobalMessage("This is a global message!", "ERROR"); // where message = "This is a global message!" and messageClass = "ERROR"
The message will be displayed on the issue screen like in the image below:
See also