dojox/xmpp/bosh.js

• Provides:

  • dojox.xmpp.bosh

• Requires:

  • dojo.io.script in common
  • dojo.io.iframe in common
  • dojox.xml.parser in common

• dojox.xmpp.bosh.__initArgs

  • type

    Function

  • summary

    The arguments passed to dojox.xmpp.bosh.initialize

• dojox.xmpp.bosh.__initArgs.constructor

  • constructor - constructor
  • type

    Function

  • summary

    The arguments passed to dojox.xmpp.bosh.initialize

• dojox.xmpp.bosh.__initArgs.iframes

  • type

    The

  • summary

    number of iframes to use for transmission

• dojox.xmpp.bosh.__initArgs.load

  • type

    The

  • summary

    function called when the first iframe is
    loaded.  Generally used to signal when to send
    login information

• dojox.xmpp.bosh.__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
    dojox.xmpp.bosh.get() calls, since it is implied that the
    return will be a string of XML.

• dojox.xmpp.bosh.__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
    dojox.xmpp.bosh.get() calls, since it is implied that the
    return will be a string of XML.

• dojox.xmpp.bosh.__ioArgs.rid

  • type

    The

  • summary

    rid of the message being sent.

• dojox.xmpp.bosh

  • type

    Object

• dojox.xmpp.bosh.transportIframes

  • type

    Array

• dojox.xmpp.bosh.initialize

  • parameters:
    • args: (typeof dojox.xmpp.bosh.__initArgs)
  • type

    Function

• dojox.xmpp.bosh.initialize.transportIframes

  • type

    Array

• dojox.xmpp.bosh._iframeOnload

  • parameters:
    • index
  • type

    Function

• dojox.xmpp.bosh.findOpenIframe

  • type

    Function

• dojox.xmpp.bosh.handle

  • parameters:
    • msg
    • rid
  • type

    Function

• dojox.xmpp.bosh.get

  • parameters:
    • args: (typeof dojox.xmpp.bosh.__ioArgs)
  • summary

    sends a get request using a dynamically created script tag.

  • type

    Function

• dojox.xmpp.bosh.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

• dojox.xmpp.bosh._makeScriptDeferred

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

    dojo.Deferred

  • summary

    sets up a Deferred object for an IO request.

  • type

    Function

• dojox.xmpp.bosh._deferredCancel

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

    canceller function for dojo._ioSetArgs call.

  • type

    Function

• dojox.xmpp.bosh._deferredOk

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

    okHandler function for dojo._ioSetArgs call.

  • type

    Function

• dojox.xmpp.bosh._deferredError

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

    errHandler function for dojo._ioSetArgs call.

  • type

    Function

• dojox.xmpp.bosh._deadScripts

  • type

    Array

• dojox.xmpp.bosh._addDeadScript

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

    sets up an entry in the deadScripts array.

  • type

    Function

• dojox.xmpp.bosh._validCheck

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

    inflight check function to see if dfd is still valid.

  • type

    Function

• dojox.xmpp.bosh._ioCheck

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

    inflight check function to see if IO finished.

  • type

    Function

• dojox.xmpp.bosh._resHandle

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

    inflight function to handle a completed response.

  • type

    Function

• dojox.xmpp

  • type

    Object

• dojox

  • type

    Object