runnerLog
Syntax | runnerLog(message [, treatAsHtml], percent]) | Package |
|
Alias |
| Pkg Usage |
|
Description
Puts the 'message' on the console of a runner gadget. The use of it has no effect in other places besides for the runner.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
message | String | Yes | Specifies the message to be put on the runner console |
percent | Number | No | Specifies the percent to be updated on the progress bar |
action | String | No | Specifies the action to be executed (so far, the only action considered is init_progressBar - to initialize the progress bar; everything else will be ignored) |
treatAsHtml | Boolean | No | Specifies either to show the message as a string, or treat it and render it in the browser as HTML code. |
Return Type
String
Return value has no meaning and should be ignored.
Examples
Example 1
runnerLog("Hello " + userFullName(currentUsername()) + ". How are you today?");Returns: Hello John Smith. How are you today?
Example 2
Using HTML as output.
runnerLog("<font color='red'>This is a red text!</font>", true);This is a red text! (text will be red)