• index
• goog
• gears
• search: Go

The goog.gears.ManagedResourceStore Class

goog.gears.ManagedResourceStore
> goog.events.EventTarget
> goog.Disposable

goog.gears.ManagedResourceStore(name, requiredCookie, opt_localServer)

Creates a ManagedResourceStore with the specified name and update. This follows the Closure event model so the COMPLETE event will fire both for SUCCESS and for ERROR. You can use {@code isSuccess} in UPDATE to see if the capture was successful or you can just listen to the different events. This supports PROGRESS events, which are fired any time {@code filesComplete} or {@code filesTotal} changes. If the Gears version is 0.3.6 or newer this will reflect the numbers returned by the underlying Gears MRS but for older Gears versions this will just be {@code 0} or {@code 1}. NOTE: This relies on at least the 0.2 version of gears (for timer).

name {string}

The name of the managed store.

requiredCookie {?string}

A cookie that must be present for the managed store to be active. Should have the form "foo=bar". Can be null if not required.

opt_localServer {GearsLocalServer=}

Gears local server -- if not set, create a new one internally.

The goog.gears.ManagedResourceStore.EventType Enum

Enum for event types fired by ManagedResourceStore. … more

.UPDATE_INTERVAL_MS {number}

The amount of time between status checks during an update

The goog.gears.ManagedResourceStore.UpdateStatus Enum

Enum for possible values of Gears ManagedResourceStore.updatedStatus … more

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.create(opt_manifestUrl)

Create the ManagedResourceStore in gears

opt_manifestUrl {string=}

The url of the manifest to associate.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.exists()

Determine if the ManagedResourceStore has been created in Gears yet

returns {boolean}

true if it has been created.

.getFilesComplete()

Number of files completed. This is 0 or 1 if the Gears version does not support progress events. If the Gears version supports progress events this will reflect the number of files that have been completed.

returns {number}

The number of completed files.

.getFilesTotal()

Number of total files to load. This is always 1 if the Gears version does not support progress events. If the Gears version supports progress events this will reflect the number of files that needs to be loaded.

returns {number}

The number of files to load.

.getLastError()

Get the last error message.

returns {string}

Last error message.

.getManifestUrl()

returns {string}

Store's current manifest URL.

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.getStatus()

returns {goog.gears.ManagedResourceStore.UpdateStatus}

The current update status.

.getVersion()

returns {?string}

The version of the managed store that is currently being served.

.isActive()

returns {boolean}

Whether there is an active request.

.isComplete()

returns {boolean}

Whether the update has completed.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.isEnabled()

returns {boolean}

Whether the store is currently enabled to serve local content.

.isSuccess()

returns {boolean}

Whether the update completed with a success.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.remove()

Remove managed store.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.setEnabled(isEnabled)

Sets whether the store is currently enabled to serve local content.

isEnabled {boolean}

True if the store is enabled and false otherwise.

.setManifestUrl(url)

url {string}

Store's new manifest URL.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

.update()

Starts an asynchronous process to update the ManagedResourcStore

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.