Constructordojox.storage.GearsStorageProvider

dojo.require("dojox.storage.GearsStorageProvider");
defined in dojox/storage/GearsStorageProvider.js

You can disable this storage provider with the following djConfig variable: var djConfig = { disableGearsStorage: true };

Authors of this storage provider- Brad Neuberg, bkn3@columbia.edu

Usage

function ()

Jump to PropertiesFunctionsBack to top

Functionclear(namespace)
Completely clears this storage system of all of it's values and keys. If 'namespace' is provided just clears the keys in that
Functionget(key, namespace)
Object Gets the value with the given key. Returns null if this key is not in the storage system.
FunctiongetKeys(namespace)
Array Enumerates all of the available keys in this storage system. return: Array of available keys
mixed The maximum storage allowed by this provider
FunctiongetMultiple(keys, namespace)
Object Gets the valuse corresponding to each of the given keys. Returns a null array element for each given key that is not in the storage system.
Array[] Returns a list of URLs that this storage provider might depend on.
FunctionhasKey(key: String, namespace: String?)
Determines whether the storage has the given key.
Boolean Determines whether this provider has a settings UI.
If this provider has a settings UI, hides it.
Allows this storage provider to initialize itself. This is called after the page has finished loading, so you can not do document.writes(). Storage Provider subclasses should initialize themselves inside of here rather than in their function constructor.
Boolean Returns whether this storage provider is available on this platform.
Boolean Returns whether this storage provider's values are persisted when this platform is shutdown.
FunctionisValidKey(keyName: String)
Boolean Subclasses can call this to ensure that the key given is valid in a consistent way across different storage providers. We use the lowest common denominator for key values allowed: only letters, numbers, and underscores are allowed. No spaces.
If a function is assigned to this property, then when the settings provider's UI is closed this function is called. Useful, for example, if the user has just cleared out all storage for this provider using the settings UI, and you want to update your UI.
Functionput(key, value, resultsHandler, namespace)
Puts a key and value into this storage system.
FunctionputMultiple(keys, values, resultsHandler, namespace)
Puts multiple keys and values into this storage system.
Functionremove(key, namespace)
Removes the given key from this storage system.
FunctionremoveMultiple(keys, namespace)
Removes the given keys from this storage system.
If this provider has a settings UI, determined by calling hasSettingsUI(), it is shown.

Jump to FunctionsPropertiesBack to top

The namespace for all storage operations. This is useful if several applications want access to the storage system from the same domain but want different storage silos.
Flag that indicates a put() call to a storage provider failed.
Flag that indicates a put() call to a storage provider is pending user approval.
Returned by getMaximumSize() if this storage provider can not determine the maximum amount of data it can support.
Returned by getMaximumSize() if this storage provider has no theoretical limit on the amount of data it can store.
Flag that indicates a put() call to a storage provider was succesful.