JSDoc: Class: Response

Response(messageID, respHandler)

Represents the response returned from the remote end after execution of its corresponding command.

The response is a mutable object passed to each command for modification through the available setters. To send data in a response, you modify the body property on the response. The body property can also be replaced completely.

The response is sent implicitly by when a command has finished executing, and any modifications made subsequent to that will have no effect.


    
    
        

    
    Constructor
    

    
    new Response(messageID, respHandler)
    

    











    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                messageID
            

            
            
                
number


            
            

            

            

            Message ID tied to the corresponding command request this is
    a response for.
        

    

        
            
                respHandler
            

            
            
                
ResponseHandler


            
            

            

            

            Function callback called on sending the response.
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        message.js, line 270
    
    

    

    

    



















    
    

    

    

    

    

    

    

    

    
        Methods

`(static) fromPacket(data) → {Response`

Converts a data packet into Response.

Parameters:

Name	Type	Description
`data`	Array.<number, number, ?, ?>	A four element array where the elements, in sequence, signifies message type, message ID, error, and result.

Source:

message.js, line 363

Throws:

If the message type is not recognised.
Type TypeError

Returns:

Representation of packet.

Type: Response

send()

Sends response using the response handler provided on construction.

Source:

message.js, line 302

Throws:

If the response has already been sent.
Type RangeError

sendConditionally(predicate)

Sends response conditionally, given a predicate.

Parameters:

Name	Type	Description
`predicate`	function	A predicate taking a Response object and returning a boolean.

Source:

message.js, line 289

sendError(err)

Send error to client.

Turns the response into an error response, clears any previously set body data, and sends it using the response handler provided on construction.

Parameters:

Name	Type	Description
`err`	Error	The Error instance to send.

Source:

message.js, line 324

Throws:

If err is not a WebDriverError, the error is propagated, i.e. rethrown.
Type Error

toPacket() → {Array}

Encodes the response to a packet.

Source:

message.js, line 341

Returns:

Packet.

Type: Array

Name	Type	Description
`messageID`	number	Message ID tied to the corresponding command request this is a response for.
`respHandler`	ResponseHandler	Function callback called on sending the response.