Class Index | File Index

Classes


Class finesse.interfaces.RequestHandlers

This "interface" defines REST Object callback handlers, passed as an argument to Object getter methods in cases where the Object is going to be created.
Defined in: finesse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Class Detail
finesse.interfaces.RequestHandlers(handlers)
Parameters:
{Object} handlers
An object containing the following (optional) handlers for the request:
  • success(rsp): A callback function for a successful request to be invoked with the following response object as its only parameter:
    • status: {Number} The HTTP status code returned
    • content: {String} Raw string of response
    • object: {Object} Parsed object of response
  • error(rsp): An error callback function for an unsuccessful request to be invoked with the error response object as its only parameter:
    • status: {Number} The HTTP status code returned
    • content: {String} Raw string of response
    • object: {Object} Parsed object of response (HTTP errors)
    • error: {Object} Wrapped exception that was caught:
      • errorType: {String} Type of error that was caught
      • errorMessage: {String} Message associated with error

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Nov 06 2017 08:00:55 GMT-0500 (EST)