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.

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

Element	Display Type	Description
key	string	A category name, followed by '.' and a message or label identifier (a "token"). Example: #categoryname.tokenname
args	string	Optional Declares an array of Strings in Java (or Arguments) If no additional arguments are passed, the message-string is displayed If arguments are passed, the call expects a token. The platform then translates the token and displays the Custom Label in the selected language.

Considerations

• The function displays the message in the UI, irrespective of any database insertions or updates (in other words, without interrupting the program flow) via the Java API
• In a JSP page, this function does nothing. Use a JavaScript alert(), instead.

Syntax

<syntaxhighlight lang="java" enclose="div">

void Functions.showMessage(String key [, String[] args]); </syntaxhighlight>

If no arguments are needed (for example, for a label in the #custom category), use:

<syntaxhighlight lang="java" enclose="div">

Functions.showMessage("#custom.label",null) </syntaxhighlight>

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