dojo/io/script.js

• Provides:

  • dojo.io.script

• dojo.io.script.__ioArgs

  • type

    Function

  • chains:
    • dojo.__IoArgs: (prototype)
    • dojo.__IoArgs: (call)
  • summary

    All the properties described in the dojo.__ioArgs type, apply to this
    type as well, EXCEPT "handleAs". It is not applicable to
    dojo.io.script.get() calls, since it is implied by the usage of
    "jsonp" (response will be a JSONP call returning JSON)
    or the response is pure JavaScript defined in
    the body of the script that was attached.

• dojo.io.script.__ioArgs.constructor

  • constructor - constructor
  • type

    Function

  • summary

    All the properties described in the dojo.__ioArgs type, apply to this
    type as well, EXCEPT "handleAs". It is not applicable to
    dojo.io.script.get() calls, since it is implied by the usage of
    "jsonp" (response will be a JSONP call returning JSON)
    or the response is pure JavaScript defined in
    the body of the script that was attached.

• dojo.io.script.__ioArgs.callbackParamName

  • type

    String

  • summary

    Deprecated as of Dojo 1.4 in favor of "jsonp", but still supported for
    legacy code. See notes for jsonp property.

• dojo.io.script.__ioArgs.jsonp

  • type

    c".

• dojo.io.script.__ioArgs.checkString

  • type

    String

  • summary

    A string of JavaScript that when evaluated like so:
    "typeof(" + checkString + ") != 'undefined'"
    being true means that the script fetched has been loaded.
    Do not use this if doing a JSONP type of call (use callbackParamName instead).

• dojo.io.script.__ioArgs.frameDoc

  • type

    Document

  • summary

    The Document object for a child iframe. If this is passed in, the script
    will be attached to that document. This can be helpful in some comet long-polling
    scenarios with Firefox and Opera.

• dojo.io.script

  • type

    Object

• dojo.io.script.get

  • parameters:
    • args: (typeof dojo.io.script.__ioArgs)
  • summary

    sends a get request using a dynamically created script tag.

  • type

    Function

• dojo.io.script.attach

  • parameters:
    • id: (typeof String)
    • url: (typeof String)
    • frameDocument: (typeof Document)
  • summary

    creates a new <script> tag pointing to the specified URL and
    adds it to the document.

  • description

    Attaches the script element to the DOM.  Use this method if you
    just want to attach a script to the DOM and do not care when or
    if it loads.

  • type

    Function

• dojo.io.script.remove

  • parameters:
    • id: (typeof String)
    • frameDocument: (typeof Document)
  • summary

    removes the script element with the given id, from the given frameDocument.
    If no frameDocument is passed, the current document is used.

  • type

    Function

• dojo.io.script._makeScriptDeferred

  • parameters:
    • args: (typeof Object)
  • returns

    dojo.Deferred

  • summary

    sets up a Deferred object for an IO request.

  • type

    Function

• dojo.io.script._deferredCancel

  • parameters:
    • dfd: (typeof Deferred)
  • summary

    canceller function for dojo._ioSetArgs call.

  • type

    Function

• dojo.io.script._deferredOk

  • parameters:
    • dfd: (typeof Deferred)
  • summary

    okHandler function for dojo._ioSetArgs call.

  • type

    Function

• dojo.io.script._deferredError

  • parameters:
    • error: (typeof Error)
    • dfd: (typeof Deferred)
  • summary

    errHandler function for dojo._ioSetArgs call.

  • type

    Function

• dojo.io.script._deadScripts

  • type

    Array

• dojo.io.script._counter

  • type

    Number

• dojo.io.script._addDeadScript

  • parameters:
    • ioArgs: (typeof Object)
  • summary

    sets up an entry in the deadScripts array.

  • type

    Function

• dojo.io.script._validCheck

  • parameters:
    • dfd: (typeof Deferred)
  • summary

    inflight check function to see if dfd is still valid.

  • type

    Function

• dojo.io.script._ioCheck

  • parameters:
    • dfd: (typeof Deferred)
  • summary

    inflight check function to see if IO finished.

  • type

    Function

• dojo.io.script._resHandle

  • parameters:
    • dfd: (typeof Deferred)
  • summary

    inflight function to handle a completed response.

  • type

    Function

• dojo.io.script._canAttach

  • parameters:
    • ioArgs: (typeof Object)
  • summary

    A method that can be overridden by other modules
    to control when the script attachment occurs.

  • type

    Function

• dojo.io.script._jsonpCallback

  • parameters:
    • json: (typeof JSON)

      Object

  • summary

    generic handler for jsonp callback. A pointer to this function
    is used for all jsonp callbacks.  NOTE: the "this" in this
    function will be the Deferred object that represents the script
    request.

  • type

    Function

• dojo.io.script._jsonpCallback.ioArgs.json

• dojo.io

  • type

    Object

• dojo

  • type

    Object