ↈ_ajax_interface Class
This is an interface description. Any class that implements the methods and properties defined here is considered a valid implementation of this interface.
Item Index
Methods
Methods
ajax
-
config
Performs an ajax request. This method takes a single argument — a configuration object — that is used to generate an HTTP request. The config object has two callback methods:
'success' and 'error' in addition to a number of properties that may be used to configure the request itself. Higher level Breeze constructs will wrap calls to the ajax adapter
into Promises. Individual adapters may add additional properties to the basic config object described below.
Parameters:
-
config
Object-
url
StringAbsolute or relative URL of the resource that is being requested.
-
type
StringHTTP method (e.g. 'GET', 'POST', etc)
-
[data]
Object | String optionalData to be sent as the request message data
-
[params]
optionalMap of strings or objects which will be sent to the server in the query string in a form encoded format - url?key1=value1&key2=value2
-
[crossDomain=false]
optional -
success
FunctionFunction called on success. successFunction(httpResponse)
-
error
FunctionFunction called on failure. errorFunction(httpResponse)
-