| Package | com.mi.rs |
| Class | public class Response |
| Inheritance | Response  Object |
| Implements | IResponse |
See also
| Property | Defined By | ||
|---|---|---|---|
| command : ICommand [read-only]
Returns the command this is the response to. | Response | ||
| error : IResponseError [read-only]
Contains information about the error, or null if no error occured. | Response | ||
| hasSubErrorResponse : Boolean [read-only]
True if any of the sub-responses is an error response. | Response | ||
| isBatchResponse : Boolean [read-only]
True if this is the response to a batch command. | Response | ||
| isErrorResponse : Boolean [read-only]
Convenience property that is true if this is an error response. | Response | ||
| result : * [read-only]
The result data structure that was returned by the RealityServer
command. | Response | ||
| subResponses : Array [read-only]
if isBatchResponse is true, then this array contains objects of
type IResponse for all the sub-commands. | Response | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a response object. | Response | ||
toString():String
Returns a string description for debugging purposes. | Response | ||
| command | property |
command:ICommand [read-only] Returns the command this is the response to.
public function get command():ICommand| error | property |
error:IResponseError [read-only] Contains information about the error, or null if no error occured.
public function get error():IResponseError| hasSubErrorResponse | property |
hasSubErrorResponse:Boolean [read-only] True if any of the sub-responses is an error response. This also takes sub-responses of nested batch commands into account. Note that the IResponse.error property only say if the batch command itself succedded or not, it does not say anything about the individual sub-commands. Each sub-command needs to be inspected, and this is a convenience method to determine if error handling is needed or not for the sub-responses.
public function get hasSubErrorResponse():Boolean| isBatchResponse | property |
isBatchResponse:Boolean [read-only] True if this is the response to a batch command. If true then the batch specific methods can be used to easier parse the sub-responses of the batch command.
public function get isBatchResponse():Boolean| isErrorResponse | property |
isErrorResponse:Boolean [read-only] Convenience property that is true if this is an error response. In this case IResponse.result will be null and IResponse.error be set to an IResponseError object containing more information about the error.
public function get isErrorResponse():Boolean| result | property |
result:* [read-only] The result data structure that was returned by the RealityServer command. The result will be null if the command experienced an error.
public function get result():*| subResponses | property |
subResponses:Array [read-only] if isBatchResponse is true, then this array contains objects of type IResponse for all the sub-commands. sub-responses are in the same order as the sub-commands were added to the original batch request.
public function get subResponses():Array| Response | () | Constructor |
public function Response(cmd:ICommand, jsonReply:Object)Creates a response object. Response objects are created automatically by the service and passed to command response handlers.
Parameterscmd:ICommand — The command this is the response to.
| |
jsonReply:Object — The "raw" jsonReply from the server.
|
| toString | () | method |
public function toString():StringReturns a string description for debugging purposes.
ReturnsString |