AgileApps Support Wiki Pre Release

Functions.showMessage

From AgileApps Support Wiki
Revision as of 22:53, 20 December 2010 by imported>Aeric (Text replace - 'showMessage(' to 'Functions.showMessage(')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Functions.showMessage(String key [, String[] args])
Description
  • Displays the message in the UI, irrespective of any database insertions or updates (without interrupting the program flow) via the Java API
  • Translates the token and displays the Custom Label in the selected language
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 arguments are passed, the call expects a token
  • If no arguments are passed, the message alone is displayed
Syntax
void Functions.showMessage(String key [, String[] args]);

If no arguments are needed, use:

Functions.showMessage("#custom.label",null)
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