dojox/io/xhrPlugins.js

• Provides:

  • dojox.io.xhrPlugins

• Requires:

  • dojo.AdapterRegistry in common
  • dojo._base.xhr in common

• dojox.io.xhrPlugins.register

  • returns

    or check to see if we have the same path

  • summary

    overrides the default xhr handler to implement a registry of
    xhr handlers

  • type

    Function

• dojox.io.xhrPlugins.addProxy

  • parameters:
    • proxyUrl: (typeof This)

      is URL to send the requests to.

  • summary

    adds a server side proxy xhr handler for cross-site URLs

  • example

    Define a proxy:
    	dojox.io.xhrPlugins.addProxy("/proxy?url=");
    And then when you call:
    	dojo.xhr("GET",{url:"http://othersite.com/file"});
    It would result in the request (to your origin server):
    	GET /proxy?url=http%3A%2F%2Fothersite.com%2Ffile HTTP/1.1

  • type

    Function

• dojox.io.xhrPlugins.addCrossSiteXhr

  • parameters:
    • url: (typeof Requests)

      that start with this URL will be considered for using
      cross-site XHR.

    • httpAdapter: (typeof This)

      allows for adapting HTTP requests that could not otherwise be
      sent with XDR, so you can use a convention for headers and PUT/DELETE methods.

  • summary

    Adds W3C Cross site XHR or XDomainRequest handling for the given URL prefix

  • description

    This can be used for servers that support W3C cross-site XHR. In order for
    a server to allow a client to make cross-site XHR requests,
    it should respond with the header like:
    	Access-Control: allow <*>
    see: http://www.w3.org/TR/access-control/

  • type

    Function

• dojox.io.xhrPlugins.fullHttpAdapter

  • parameters:
    • plainXhr
    • noRawBody
  • summary

    Provides a HTTP adaption.

  • description

    The following convention is used:
    method name -> ?http-method=PUT
    Header -> http-Header-Name=header-value
    X-Header -> header_name=header-value

  • example

    dojox.io.xhrPlugins.addXdr("http://somesite.com", dojox.io.xhrPlugins.fullHttpAdapter);

  • type

    Function

• dojox.io.xhrPlugins

  • type

    Object

• dojox.io

  • type

    Object

• dojox

  • type

    Object