Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Migrated to Confluence 5.3
Excerpt |
---|
Message output handler. |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
out(message[, selfsdo[, method[, config]]]); |
Parameters
Parameter | Type | Mandatory | Description | API Version | ||||
---|---|---|---|---|---|---|---|---|
message | String Array of String | The message to output – either a single string or an array of strings. | 1.0 | |||||
selfsdo | Self Descriptor Object | Optional descriptor object, used to create a prefix to the message before it is output. If you're using the method or config params, but don't want to use an SDO, specify Default: No prefix | 1.0 | |||||
method | Constant | Constant defining desired output destination:
Default: | 1.0 | |||||
config | Variant | Optional method-specific config:
| 1.0 |
Return value
The return value of the output method will be returned (see documentation for out.*
constants above for more information).
Example
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
var self = {file: "foo.js", ver: 1.2}; out("hello", self, out.CONSOLE); // "[foo.js v1.2] hello" |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
out(["bob", "jim", "kate"]); // outputs each name on a new line to out.DEFAULT |
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
This feature requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||
---|---|---|
| ||
See alsoRelated articles:
Related APIs: |
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
GlobalsTopics:
|