dojox/atom/io/Connection.js

• Provides:

  • dojox.atom.io.Connection

• Requires:

  • dojox.atom.io.model in common

• dojox.atom.io.Connection

  • type

    Function

  • parameters:
    • sync: (typeof Boolean)
    • preventCache: (typeof Boolean)
  • summary

    This object implements a transport layer for working with ATOM feeds and ATOM publishing protocols.

  • description

    This object implements a transport layer for working with ATOM feeds and ATOM publishing protocols.
    Specifically, it provides a mechanism by which feeds can be fetched and entries can be fetched, created
    deleted, and modified.  It also provides access to the introspection data.

• dojox.atom.io.Connection.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • sync: (typeof Boolean)
    • preventCache: (typeof Boolean)
  • summary

    initializer

• dojox.atom.io.Connection.preventCache

  • type

    bool

• dojox.atom.io.Connection.alertsEnabled

  • type

    bool

• dojox.atom.io.Connection.getFeed

  • parameters:
    • url: (typeof String)

      The URL of the ATOM feed to fetch.

    • callback: (typeof Function)

      A function reference that will handle the feed when it has been retrieved.
      The callback should accept two parameters:  The feed object and the original complete DOM object.

    • errorCallback: (typeof Function)
    • scope: (typeof Object)

      The scope to use for all callbacks.

  • summary

    Function to obtain a s specific ATOM feed from a given ATOM Feed url.

  • description

    This function takes the URL for a specific ATOM feed and returns
    the data from that feed to the caller through the use of a callback
    handler.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.getService

  • parameters:
    • url: (typeof String)

      The URL of the ATOM document to obtain the introspection document of.

    • callback: (typeof Function)

      A function reference that will handle the introspection document when it has been retrieved.
      The callback should accept two parameters:  The introspection document object and the original complete DOM object.

    • errorCallback
    • scope
  • summary

    Function to retrieve an introspection document from the given URL.

  • description

    This function takes the URL for an ATOM item and feed and returns
    the introspection document.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.getEntry

  • parameters:
    • url: (typeof String)

      The URL of the ATOM Entry document to parse.

    • callback: (typeof Function)

      A function reference that will handle the Entry object obtained.
      The callback should accept two parameters, the dojox.atom.io.model.Entry object and the original dom.

    • errorCallback
    • scope
  • summary

    Function to retrieve a single entry from an ATOM feed from the given URL.

  • description

    This function takes the URL for an ATOM entry and returns the constructed dojox.atom.io.model.Entry object through
    the specified callback.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection._getXmlDoc

  • parameters:
    • url: (typeof String)

      The URL of the XML document to retrieve

    • nodeName
    • newNode
    • namespace
    • callback: (typeof Function)

      A function reference that will handle the retrieved XML data.
      The callback should accept one parameter, the DOM of the parsed XML document.

    • errorCallback
    • scope
  • summary

    Internal Function to retrieve an XML document and pass the results to a callback.

  • description

    This internal function takes the URL for an XML document and and passes the
    parsed contents to a specified callback.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.updateEntry

  • parameters:
    • entry: (typeof Object)

      The dojox.atom.io.model.Entry object to update.

    • callback: (typeof Function)

      A function reference that will handle the results from the entry update.
      The callback should accept two parameters:  The first is an Entry object, and the second is the URL of that Entry
      Either can be null, depending on the value of retrieveUpdated.

    • errorCallback
    • retrieveUpdated: (typeof boolean)

      A boolean flag denoting if the entry that was updated should then be
      retrieved and returned to the caller via the callback.

    • xmethod: (typeof boolean)

      Whether to use POST for PUT/DELETE items and send the X-Method-Override header.

    • scope: (typeof Object)

      The scope to use for all callbacks.

  • summary

    Function to update a specific ATOM entry by putting the new changes via APP.

  • description

    This function takes a specific dojox.atom.io.model.Entry object and pushes the
    changes back to the provider of the Entry.
    The entry MUST have a link tag with rel="edit" for this to work.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.addEntry

  • parameters:
    • entry: (typeof Object)

      The dojox.atom.io.model.Entry object to publish.

    • url
    • callback: (typeof Function)

      A function reference that will handle the results from the entry publish.
      The callback should accept two parameters:   The first is an dojox.atom.io.model.Entry object, and the second is the location of the entry
      Either can be null, depending on the value of retrieveUpdated.

    • errorCallback
    • retrieveEntry: (typeof boolean)

      A boolean flag denoting if the entry that was created should then be
      retrieved and returned to the caller via the callback.

    • scope: (typeof Object)

      The scope to use for all callbacks.

  • summary

    Function to add a new ATOM entry by posting the new entry via APP.

  • description

    This function takes a specific dojox.atom.io.model.Entry object and pushes the
    changes back to the provider of the Entry.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.deleteEntry

  • parameters:
    • entry: (typeof Object)

      The dojox.atom.io.model.Entry object to delete.

    • callback: (typeof Function)

      A function reference that will handle the results from the entry delete.
      The callback is called only if the delete is successful.

    • errorCallback
    • xmethod
    • scope
  • summary

    Function to delete a specific ATOM entry via APP.

  • description

    This function takes a specific dojox.atom.io.model.Entry object and calls for a delete on the
    service housing the ATOM Entry database.
    The entry MUST have a link tag with rel="edit" for this to work.

  • return_summary

    Nothing. The return is handled through the callback handler.

  • type

    Function

• dojox.atom.io.Connection.sync

• dojox.atom.io

  • type

    Object

• dojox.atom

  • type

    Object

• dojox

  • type

    Object