dojox/storage/manager.js

• Provides:

  • dojox.storage.manager

• dojox.storage.manager

  • summary

    A singleton class in charge of the dojox.storage system

  • description

    Initializes the storage systems and figures out the best available
    storage options on this platform.

  • type

    Function

• dojox.storage.manager.currentProvider

  • type

    Object

  • summary

    The storage provider that was automagically chosen to do storage
    on this platform, such as dojox.storage.FlashStorageProvider.

• dojox.storage.manager.available

  • type

    Object

• dojox.storage.manager.providers

  • type

    Array

• dojox.storage.manager._initialized

  • type

    Object

• dojox.storage.manager._onLoadListeners

  • type

    Array

• dojox.storage.manager.initialize

  • summary

    Initializes the storage system and autodetects the best storage
    provider we can provide on this platform

  • type

    Function

• dojox.storage.manager.register

  • parameters:
    • name: (typeof string)

      The full class name of this provider, such as
      "dojox.storage.FlashStorageProvider".

    • instance: (typeof Object)

      An instance of this provider, which we will use to call
      isAvailable() on.

  • summary

    Registers the existence of a new storage provider; used by
    subclasses to inform the manager of their existence. The
    storage manager will select storage providers based on
    their ordering, so the order in which you call this method
    matters.

  • type

    Function

• dojox.storage.manager.setProvider

  • parameters:
    • storageClass
  • summary

    Instructs the storageManager to use the given storage class for
    all storage requests.

  • description

    Example-
    dojox.storage.setProvider(
    dojox.storage.IEStorageProvider)

  • type

    Function

• dojox.storage.manager.autodetect

  • summary

    Autodetects the best possible persistent storage provider
    available on this platform.

  • type

    Function

• dojox.storage.manager.isAvailable

  • summary

    Returns whether any storage options are available.

  • type

    Function

• dojox.storage.manager.addOnLoad

  • parameters:
    • func: (typeof Function)

      A function to call when Dojo Offline is ready to go

  • summary

    Adds an onload listener to know when Dojo Offline can be used.

  • description

    Adds a listener to know when Dojo Offline can be used. This
    ensures that the Dojo Offline framework is loaded and that the
    local dojox.storage system is ready to be used. This method is
    useful if you don't want to have a dependency on Dojo Events
    when using dojox.storage.

  • type

    Function

• dojox.storage.manager.removeOnLoad

  • parameters:
    • func
  • summary

    Removes the given onLoad listener

  • type

    Function

• dojox.storage.manager.isInitialized

  • summary

    Returns whether the storage system is initialized and ready to
    be used.

  • type

    Function

• dojox.storage.manager.supportsProvider

  • parameters:
    • storageClass: (typeof string)
  • summary

    Determines if this platform supports the given storage provider.

  • description

    Example-
    dojox.storage.manager.supportsProvider(
    "dojox.storage.InternetExplorerStorageProvider");

  • type

    Function

• dojox.storage.manager.getProvider

  • summary

    Gets the current provider

  • type

    Function

• dojox.storage.manager.loaded

  • summary

    The storage provider should call this method when it is loaded
    and ready to be used. Clients who will use the provider will
    connect to this method to know when they can use the storage
    system. You can either use dojo.connect to connect to this
    function, or can use dojox.storage.manager.addOnLoad() to add
    a listener that does not depend on the dojo.event package.

  • description

    Example 1-
    if(dojox.storage.manager.isInitialized() == false){
    dojo.connect(dojox.storage.manager, "loaded", TestStorage, "initialize");
    }else{
    dojo.connect(dojo, "loaded", TestStorage, "initialize");
    }
    Example 2-
    dojox.storage.manager.addOnLoad(someFunction);

  • type

    Function

• dojox.storage.manager._fireLoaded

  • type

    Function

• dojox.storage.manager.getResourceList

  • summary

    Returns a list of whatever resources are necessary for storage
    providers to work.

  • description

    This will return all files needed by all storage providers for
    this particular environment type. For example, if we are in the
    browser environment, then this will return the hidden SWF files
    needed by the FlashStorageProvider, even if we don't need them
    for the particular browser we are working within. This is meant
    to faciliate Dojo Offline, which must retrieve all resources we
    need offline into the offline cache -- we retrieve everything
    needed, in case another browser that requires different storage
    mechanisms hits the local offline cache. For example, if we
    were to sync against Dojo Offline on Firefox 2, then we would
    not grab the FlashStorageProvider resources needed for Safari.

  • type

    Function

• dojox.storage

  • type

    Object

• dojox

  • type

    Object