Difference between revisions of "NXSL:PostEvent"
Jump to navigation
Jump to search
(Created page with "__NOTOC__ Post event on behalf of given node. == Syntax == PostEvent(''node'', ''event'', ''tag'', ...); == Parameters == :{| |- | ''node'' || Node object to send event ...") |
m (Text replacement - "^" to "{{deprecated}}") |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | {{deprecated}}__NOTOC__ | ||
Post event on behalf of given node. | Post event on behalf of given node. | ||
'''Since:''' 1.0.8 | |||
== Syntax == | == Syntax == | ||
| Line 14: | Line 15: | ||
| ''node'' || Node object to send event on behalf of. | | ''node'' || Node object to send event on behalf of. | ||
|- | |- | ||
| ''event'' || Event code. | | ''event'' || Event code or name (name can be used since 1.2.6). | ||
|- | |- | ||
| ''tag'' || User tag associated with event. Optional, can be leaved out or set to '''null'''. | | ''tag'' || User tag associated with event. Optional, can be leaved out or set to '''null'''. | ||
| Line 31: | Line 32: | ||
PostEvent($node, 100000) | PostEvent($node, 100000) | ||
PostEvent($node, 100000, "my tag", "param1", "param2") | PostEvent($node, 100000, "my tag", "param1", "param2") | ||
PostEvent($node, | PostEvent($node, "MY_EVENT_NAME", null, "param1") | ||
Latest revision as of 16:13, 13 September 2022
| This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide) |
Post event on behalf of given node.
Since: 1.0.8
Syntax
PostEvent(node, event, tag, ...);
Parameters
node Node object to send event on behalf of. event Event code or name (name can be used since 1.2.6). tag User tag associated with event. Optional, can be leaved out or set to null. ... 0 or more event-specific parameters.
Return Value
TRUE if event was posted successfully or FALSE if not.
Examples
PostEvent($node, 100000) PostEvent($node, 100000, "my tag", "param1", "param2") PostEvent($node, "MY_EVENT_NAME", null, "param1")