akasha.idb

Class IDBRequest

java.lang.Object

akasha.EventTarget

akasha.idb.IDBRequest

Direct Known Subclasses:

IDBOpenDBRequest

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="IDBRequest")
public class IDBRequest
extends EventTarget

The IDBRequest interface of the IndexedDB API provides access to results of asynchronous requests to databases and database objects using event handler attributes. Each reading and writing operation on a database is done using a request.

See Also:

IDBRequest - MDN, IDBRequest - Indexed Database API 2.0, IDBRequest - Indexed Database API 2.0

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onerror The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store.
EventHandler	onsuccess The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBRequest()

Method Summary

Modifier and Type	Method and Description
void	addErrorListener(EventListener callback)
void	addErrorListener(EventListener callback, AddEventListenerOptions options)
void	addErrorListener(EventListener callback, boolean useCapture)
void	addSuccessListener(EventListener callback)
void	addSuccessListener(EventListener callback, AddEventListenerOptions options)
void	addSuccessListener(EventListener callback, boolean useCapture)
DOMException	error() A DOMError containing the relevant error.
java.lang.String	readyState() The IDBRequestReadyState of the request, which takes one of the following two values:
void	removeErrorListener(EventListener callback)
void	removeErrorListener(EventListener callback, boolean useCapture)
void	removeErrorListener(EventListener callback, EventListenerOptions options)
void	removeSuccessListener(EventListener callback)
void	removeSuccessListener(EventListener callback, boolean useCapture)
void	removeSuccessListener(EventListener callback, EventListenerOptions options)
jsinterop.base.Any	result() any
IDBObjectStoreOrIDBIndexOrIDBCursorUnion	source() An object representing the source of the request, such as an IDBIndex, IDBObjectStore or IDBCursor.
IDBTransaction	transaction() An IDBTransaction.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onerror

@Nullable
public EventHandler onerror

The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store. Also included at the bottom is an onerror function that reports what the error was if the request fails. For a full working example, see our To-do Notifications app (view example live.)

See Also:

IDBRequest.onerror - MDN, onerror - Indexed Database API 2.0, onerror - Indexed Database API Draft

onsuccess

@Nullable
public EventHandler onsuccess

The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store. For a full working example, see our To-do Notifications app (view example live.)

See Also:

IDBRequest.onsuccess - MDN, onsuccess - Indexed Database API 2.0, onsuccess - Indexed Database API Draft

Constructor Detail

IDBRequest

protected IDBRequest()

Method Detail

error

@JsProperty(name="error")
 @Nullable
public DOMException error()

A DOMError containing the relevant error. In Chrome 48+/Firefox 58+ this property returns a DOMException because DOMError has been removed from the DOM standard. The following error codes are returned under certain conditions:

See Also:

IDBRequest.error - MDN, error - Indexed Database API 2.0, error - Indexed Database API Draft

readyState

@JsProperty(name="readyState")
 @Nonnull
 @IDBRequestReadyState
public java.lang.String readyState()

The IDBRequestReadyState of the request, which takes one of the following two values:

See Also:

IDBRequest.readyState - MDN, readyState - Indexed Database API 2.0, readyState - Indexed Database API Draft

result

@JsProperty(name="result")
 @Nullable
public jsinterop.base.Any result()

any

See Also:

IDBRequest.result - MDN, result - Indexed Database API 2.0, result - Indexed Database API Draft

source

@JsProperty(name="source")
 @Nullable
public IDBObjectStoreOrIDBIndexOrIDBCursorUnion source()

An object representing the source of the request, such as an IDBIndex, IDBObjectStore or IDBCursor.

See Also:

IDBRequest.source - MDN, source - Indexed Database API 2.0, source - Indexed Database API Draft

transaction

@JsProperty(name="transaction")
 @Nullable
public IDBTransaction transaction()

An IDBTransaction.

See Also:

IDBRequest.transaction - MDN, transaction - Indexed Database API 2.0, transaction - Indexed Database API Draft

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback)

addSuccessListener

@JsOverlay
public final void addSuccessListener(@Nonnull
                                                EventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addSuccessListener

@JsOverlay
public final void addSuccessListener(@Nonnull
                                                EventListener callback,
                                                boolean useCapture)

addSuccessListener

@JsOverlay
public final void addSuccessListener(@Nonnull
                                                EventListener callback)

removeSuccessListener

@JsOverlay
public final void removeSuccessListener(@Nonnull
                                                   EventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeSuccessListener

@JsOverlay
public final void removeSuccessListener(@Nonnull
                                                   EventListener callback,
                                                   boolean useCapture)

removeSuccessListener

@JsOverlay
public final void removeSuccessListener(@Nonnull
                                                   EventListener callback)