Documentation

RequestProperties

An object containing the options of a Request

Properties:
Name Type Description
url String

the url to request from the host application, relative to the host's context path

type String

the HTTP method name; defaults to 'GET'

data String

the string entity body of the request; required if type is 'POST' or 'PUT'

contentType String

the content-type string value of the entity body, above; required when data is supplied

headers Object

an object containing headers to set; supported headers are: Accept

success function

a callback function executed on a 200 success status code

error function

a callback function executed when a HTTP status error code is returned