Functions.showMessage

Description

This function displays a message to the user, either at the top of page or in a dialog, depending on the context, using the Java API.

• The basic version of the function displays a message string.
• With additional options, a localized version of a message can displayed.

Considerations

• The function displays the message in the UI, irrespective of any database insertions or updates (in other words, without interrupting the program flow).
• If the function is called multiple times, the messages are concatenated, and displayed together when the code returns to the platform. (Only one dialog is ever displayed.)
• The text is displayed in HTML format, so linebreaks (<br>) and text formatting (<b>, <i>) can be included.
• In a JSP page, this function does nothing. Use a JavaScript alert(), instead.

Syntax

void Functions.showMessage(String message);
void Functions.showMessage(String key, String[] args);

To display a localized message:

Element	Type	Description
key	String	A category name, followed by '.' and a message or label identifier (a "token"). Example: #categoryname.tokenname
args	Array of String	Optional. Causes the first parameter to be treated as a key. If no additional arguments are passed, the original key (the message string) is displayed. If arguments are passed, the key is used to retrieve a Custom Label in the current language, with the supplied arguments injected into it.

To provide a key for a label that has no arguments (for example, for a label in the #custom category), use:

Functions.showMessage("#custom.label", null)

To include linebreaks in the message, specify <br>:

Functions.showMessage("Include <br> for <br> newline");

Return

• Returns the localized message configured on the key in the Translation Workbench.
• If no key is configured in the translation workbench, then the passed key is returned.