senselogic.sitevision.api.script

Interface JsonRequesterPromise<O,F>

Type Parameters:

O - script object

F - script function

All Superinterfaces:

JsonRequester<O,F>

public interface JsonRequesterPromise<O,F>
extends JsonRequester<O,F>

The chained result of an JsonRequester invocation.

Since:

SiteVision 4.2

Author:

Magnus Lövgren

See Also:

JsonRequester

Method Summary

Modifier and Type	Method and Description
JsonRequesterPromise<O,F>	done(F aCallback) Invoked when a JsonRequester was successfully executed.
JsonRequesterPromise<O,F>	fail(F aCallback) Invoked when a JsonRequester was unsuccessfully executed.

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

delete, delete, get, get, post, post, put, put

Method Detail

done

JsonRequesterPromise<O,F> done(F aCallback)

Invoked when a JsonRequester was successfully executed.

The callback is invoked with two 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.

Parameters:

aCallback - a callback function that handles the JSON result

Returns:

the promise

fail

JsonRequesterPromise<O,F> fail(F aCallback)

Invoked when a JsonRequester 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 three 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.
   • 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 that specifies application/json in the Content-Type header)

Parameters:

aCallback - a callback function that handles fail state

Returns:

the promise