• index
• goog
• gears
• search: Go

The goog.gears.UrlCapture Class

goog.gears.UrlCapture
> goog.events.EventTarget
> goog.Disposable

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

Class capture URLs to a ResourceStore on the LocalServer.

name {string}

The name of the ResourceStore to capture the URLs to.

requiredCookie {?string}

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

opt_localServer {GearsResourceStore=}

The LocalServer for gears.

The goog.gears.UrlCapture.Event Class

An event dispatched by UrlCapture … more

The goog.gears.UrlCapture.EventType Enum

Events fired during URL capture … more

.abort(captureId)

Aborts the capture with the given id. Dispatches abort event.

captureId {number}

The id of the capture to abort, from #capture.

.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.

.capture(uris)

Starts the capture of the given URLs. Returns immediately, and fires events on success and error.

uris {Array.<string|goog.Uri>}

URIs to capture.

returns {number}

The id of the ResourceStore capture. Can be used to abort, or identify events.

.copy(srcUri, dstUri)

Copies a Url that's been captured.

srcUri {string|goog.Uri}

The source Uri.

dstUri {string|goog.Uri}

The destination Uri.

.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 UrlCapture has been created.

returns {boolean}

True if it has been created.

.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.

.isCaptured(uri)

Checks if a URL is captured.

uri {string|goog.Uri}

The URL to check.

returns {boolean}

true if captured, false otherwise.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.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(uri)

Removes the given URI from the store.

uri {string|goog.Uri}

The URI to remove from the 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.

.removeStore()

Remove this resource store.

.rename(srcUri, dstUri)

Renames a Url that's been captured.

srcUri {string|goog.Uri}

The source Uri.

dstUri {string|goog.Uri}

The destination Uri.

.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).

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