senselogic.sitevision.api.script

Interface RequesterChainable<O,F>

Type Parameters:

O - script object

F - script function

All Superinterfaces:

Requester<O,F>

public interface RequesterChainable<O,F>
extends Requester<O,F>

The chainable result of a Requester invocation.

Since:

Sitevision 4.2

Author:

Magnus Lövgren

See Also:

Requester

Method Summary

Modifier and Type	Method and Description
RequesterChainable<O,F>	done(F aCallback) Invoked when a Requester was successfully executed (response with a status in the 2xx series).
RequesterChainable<O,F>	fail(F aCallback) Invoked when a Requester was unsuccessfully executed.

Methods inherited from interface senselogic.sitevision.api.script.Requester

delete, delete, get, get, head, head, patch, patch, post, post, put, put

Method Detail

done

RequesterChainable<O,F> done(F aCallback)

Invoked when a Requester was successfully executed (response with a status in the 2xx series).

The callback is invoked with three optional arguments:

1. First argument is the result - typically a JSON object.
2. Second argument [@since Sitevision 4.2.3] is the statusCode - the http response status code.
3. Third argument [@since Sitevision 4.5.1] is the headers - the http response headers.

Parameters:

aCallback - a callback function that handles the result

Returns:

a chainable requester

fail

RequesterChainable<O,F> fail(F aCallback)

Invoked when a Requester was unsuccessfully executed.

The callback is invoked with two optional arguments:

1. First argument is the message - a string that describes the fail reason.
2. Second argument [@since Sitevision 4.2.2] is the status - an object with four properties:
   • statusCode - the http response status code.
     The value will typically be an official/RFC-standardized code (such as 400, 401, 404, 500 etc), but it can also be an unofficial/non-standardized one. A connection timeout will have value 1000 and the value will be 1001 if the connection pool is full/exhausted. An unknown/unspecified error will have value -1, such as unknown host, illegal url or network connection errors.
   • statusMessage - the http response status code description.
   • body [@since Sitevision 4.2.3] - the potential JSON body of the response. (Note! Will only be available for responses with a Content-Type header indicating the JSON format)
   • headers [@since Sitevision 4.5.1] - the potential response headers. (Note! Will only be available for valid error responses, not for request errors, JSON parse errors or such)

Parameters:

aCallback - a callback function that handles fail state

Returns:

a chainable requester