presentation-request

Augmented.js Presentation Request Module

API

Table of Contents

• Configuration
  • uri
    • Properties
  • url
    • Properties
  • contentType
    • Properties
  • dataType
    • Properties
  • method
    • Properties
  • method
    • Properties
  • cache
    • Properties
  • timeout
    • Properties
  • crossDomain
    • Properties
  • withCredentials
    • Properties
  • user
    • Properties
  • password
    • Properties
  • allowOrigins
    • Properties
  • allowMethods
    • Properties
  • headers
    • Properties
  • success
    • Properties
  • error
    • Properties
  • complete
    • Properties
  • beforeSend
    • Properties
  • mock
    • Properties
• xhrFields
• request
  • Parameters
  • Examples
• sync
  • Parameters

Configuration

Object of configuration properties and callbacks. Pass this to the request call to setup configutation

uri

uri property

Properties

• uri string the uri

url

url property

Properties

• url string the url

Meta

• deprecated: This is deprecated.

contentType

contentType property

Properties

• contentType string the content type (default is text/plain)

dataType

dataType property

Properties

• dataType string the data type (default is text)

method

async property - no longer supported

Properties

• async boolean set async (default true)

method

method property

Properties

• method string the ajax method (default GET)

cache

cache property

Properties

• cache boolean the cache toggle (default true)

timeout

timeout property

Properties

• timeout number the timeout property

crossDomain

crossDomain property - sets withCredentials to true

Properties

• crossDomain boolean the cross domain property

withCredentials

withCredentials property

Properties

• withCredentials boolean the setting for credentails

user

user property

Properties

• user string the username for credentials

password

password property

Properties

• password string the password for credentials

allowOrigins

allowOrigins property

Properties

• allowOrigins string the allowed origins for crossDomain

allowMethods

allowMethods property

Properties

• allowMethods string the allowed methods for crossDomain

headers

headers property

Properties

• headers object an object of headers (key, value)

success

success callback

Properties

• success function a callback for success

error

error callback

Properties

• error function a callback for error

complete

complete callback

Properties

• complete function a callback after the ajax call

beforeSend

beforeSend callback

Properties

• beforeSend function a callback before the ajax call

mock

mock

Properties

• mock boolean a toggle to mock the ajax call

xhrFields

xhrFields property

request

AJAX capability using simple jQuery-like API Supports the following object properties and features:

Parameters

• configuration Configuration object of configuration properties and callbacks.

Examples

request({
        uri: uri,
        contentType: "text/plain",
        dataType: "text",
        success: function (data, status) { ... },
        error: function (data, status) { ... }
    });

Returns any success or failure callback

Meta

• deprecated: Use fetch or sync

sync

Base sync method that can pass special augmented features

Parameters

• method (optional, default METHOD_MAP.READ)
• model
• options (optional, default {})