Difference between revisions of "ISUplink:Relay (Command)"
| (14 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
== Syntax == | == Syntax == | ||
| + | relay <uplink name|session name|all|all local> [-echo|-event <name>|-noredirect] <message|command> | ||
| + | |||
| + | Note: To send a command to your local uplink, use the uplink command. | ||
== Description == | == Description == | ||
| + | Relays a command to a given session. This is ''asynchronous'' -- the command is not guaranteed to have executed in the given session by the time this command completes. If "all" is used, the command is broadcast to all sessions (including remote). If "all local" is used, the command is broadcast to all ''local'' sessions. | ||
| + | |||
| + | == Note == | ||
| + | From Lax: When you relay, the output of the command is sent to the sender, not displayed on the remote session. The -noredirect switch makes it so the output is displayed on the remote session | ||
| + | |||
| + | The uplink's name, is the same as the system-name. The system-name can be read with ${SettingXML[InnerSpace.XML].Set[Remote].GetString[Name].Escape} | ||
== Examples == | == Examples == | ||
| + | *Relay is1 "Press 1" | ||
| + | : From the uplink | ||
| + | *Relay is1 "Press Alt+F1" | ||
| + | : From a session | ||
| + | *Relay all -echo "Hi" | ||
| + | *Relay "all local" -echo "Hi" | ||
| + | : Relaying a ''single-parameter'' event execution | ||
| + | *Relay all -event EVENT_NAME Param1 | ||
| + | : Relaying a multi-parameter event execution | ||
| + | *Relay all "Event[EVENT_NAME]:Execute[param1,param2,\"param3 has quotes\"]" | ||
== See Also == | == See Also == | ||
| Line 10: | Line 29: | ||
{{Command-Stub}} | {{Command-Stub}} | ||
| + | [[Category:Inner Space]] | ||
| + | [[Category:Inner Space Uplink]] | ||
| + | [[Category:Inner Space Uplink Commands]] | ||
Latest revision as of 15:23, 15 December 2018
Contents
Syntax
relay <uplink name|session name|all|all local> [-echo|-event <name>|-noredirect] <message|command>
Note: To send a command to your local uplink, use the uplink command.
Description
Relays a command to a given session. This is asynchronous -- the command is not guaranteed to have executed in the given session by the time this command completes. If "all" is used, the command is broadcast to all sessions (including remote). If "all local" is used, the command is broadcast to all local sessions.
Note
From Lax: When you relay, the output of the command is sent to the sender, not displayed on the remote session. The -noredirect switch makes it so the output is displayed on the remote session
The uplink's name, is the same as the system-name. The system-name can be read with ${SettingXML[InnerSpace.XML].Set[Remote].GetString[Name].Escape}
Examples
- Relay is1 "Press 1"
- From the uplink
- Relay is1 "Press Alt+F1"
- From a session
- Relay all -echo "Hi"
- Relay "all local" -echo "Hi"
- Relaying a single-parameter event execution
- Relay all -event EVENT_NAME Param1
- Relaying a multi-parameter event execution
- Relay all "Event[EVENT_NAME]:Execute[param1,param2,\"param3 has quotes\"]"
