Command

Command objects are returned when calling capability methods. Command objects allow listening for success/cancel events from the request.

Example:

var command = device.getLauncher().launchBrowser(url);

command.success(function (launchSession) {
    console.log("command was successful");
}).error(function (err) {
    console.error("command failed");
});

Mixin Methods - SimpleEventEmitter

command.addListener (event, callback, [context])

Add event listener.

Parameters:
  • event (string)

    name of event

  • callback (function)

    function to call when event is fired

  • context (object) [optional]

    object to bind to "this" value when calling function

Returns:
object –

reference to the same object to allow chaining

command.removeListener (event, [callback], [context])

Remove event listener with the specified callback and context. If callback is null or undefined, all callbacks for this event will be removed.

Parameters:
  • event (string)

    name of event

  • callback (function) [optional]

    function originally passed to addListener

  • context (object) [optional]

    context object originally passed to addListener

Returns:
object –

reference to the same object to allow chaining

command.on (event, callback, [context])

Alias for addListener.

Parameters:
  • event (string)

    name of event

  • callback (function)

    function to call when event is fired

  • context (object) [optional]

    object to bind to "this" value when calling function

Returns:
object –

reference to the same object to allow chaining

command.off (event, [callback], [context])

Alias for removeListener.

Parameters:
  • event (string)

    event name

  • callback (function) [optional]

    function originally passed to on

  • context (object) [optional]

    context object originally passed to on

Returns:
object –

reference to the same object to allow chaining

Mixin Methods - SuccessCallbacks

command.success (callback, [context])

Register a callback for the "success" event. The success callback may be called with zero or more arguments depending on the type of response.

Example:

obj.success(function (result) {
    this.report("I got a result: " + result);
}, this);
Parameters:
  • callback (function)

    function to call when event is fired

  • context (*) [optional]

    object to bind to "this" value when calling function

Returns:
object –

reference to the same object to allow chaining

command.error (callback, [context])

Register a callback for the "error" event. The error callback will be called with a error object as the only argument.

Example:

obj.error(function (err) {
    this.reportError("I got an error: " + err);
}, this);
Parameters:
  • callback (function)

    function to call when event is fired

  • context (*) [optional]

    object to bind to "this" value when calling function

Returns:
object –

reference to the same object to allow chaining

command.complete (callback, [context])

Register a callback for the "complete" event. The complete callback will be called with

Example:

obj.complete(function (err, result) {
    if (err) {
        this.report("I got an error: " + err);
    } else {
        console.log("I got a result: " + result);
    }
}, this);
Parameters:
  • callback (function)

    function to call when event is fired

  • context (*) [optional]

    object to bind to "this" value when calling function

Returns:
object –

reference to the same object to allow chaining