com.mi.rs.Command Class Reference

Description

The Command class that wraps the information needed to execute a command.

Boolean isCancelled: [read-only] This property is set to true if the command has been cancelled, in which case it will simply be skipped by the service. More...
String name: [read-only] The name of the RealityServer command.
Object params: [read-only] Command parameters specified as an associative array.

com.mi.rs.Command( String name, Object params)

Creates a Command object.

String com.mi.rs.Command.prototype.toString(): Returns a string describing this Object.

Returns

A String describing this Object.

Boolean com.mi.rs.Command.prototype.isCancelled: [read-only] This property is set to true if the command has been cancelled, in which case it will simply be skipped by the service. This property is set to true by the implementing class if the command has been cancelled, in which case it will simply be skipped by the service. Note that commands are normally processed immediately after being added by a process commands callback at which point this property does not have any effect. Most command implementations should just return false, but there are special cases, like render commands or other commands that return binary data, where this mechanism can be of use.
String com.mi.rs.Command.prototype.name: [read-only] The name of the RealityServer command.
Object com.mi.rs.Command.prototype.params: [read-only] Command parameters specified as an associative array.