akasha.idb

Class IDBTransaction

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.idb.IDBTransaction

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

The IDBTransaction interface of the IndexedDB API provides a static, asynchronous transaction on a database using event handler attributes. All reading and writing of data is done within transactions. You use IDBDatabase to start transactions, IDBTransaction to set the mode of the transaction (e.g. is it readonly or readwrite), and you access an IDBObjectStore to make a request. You can also use an IDBTransaction object to abort transactions.

See Also:

IDBTransaction - MDN, (Indexed DB 3.0) # transaction

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onabort In the following code snippet, we open a read/write transaction on our database and add some data to an object store.
EventHandler	oncomplete The oncomplete event handler of the IDBTransaction interface handles the complete event, fired when the transaction successfully completes.
EventHandler	onerror The onerror event handler of the IDBTransaction interface handles the error event, fired when a request returns an error and bubbles up to the transaction object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBTransaction()

Method Summary

Modifier and Type	Method and Description
void	abort() The abort() method of the IDBTransaction interface rolls back all the changes to objects in the database associated with this transaction.
void	addAbortListener(EventListener callback)
void	addAbortListener(EventListener callback, AddEventListenerOptions options)
void	addAbortListener(EventListener callback, boolean useCapture)
void	addCompleteListener(EventListener callback)
void	addCompleteListener(EventListener callback, AddEventListenerOptions options)
void	addCompleteListener(EventListener callback, boolean useCapture)
void	addErrorListener(EventListener callback)
void	addErrorListener(EventListener callback, AddEventListenerOptions options)
void	addErrorListener(EventListener callback, boolean useCapture)
void	commit() The commit() method of the IDBTransaction interface commits the transaction if it is called on an active transaction.
IDBDatabase	db() An IDBDatabase object.
java.lang.String	durability()
DOMException	error() A DOMError containing the relevant error.
java.lang.String	mode() An IDBTransactionMode object defining the mode for isolating access to data in the current object stores:
IDBObjectStore	objectStore(java.lang.String name) The objectStore() method of the IDBTransaction interface returns an object store that has already been added to the scope of this transaction.
DOMStringList	objectStoreNames() The objectStoreNames read-only property of the IDBTransaction interface returns a DOMStringList of names of IDBObjectStore objects.
void	removeAbortListener(EventListener callback)
void	removeAbortListener(EventListener callback, boolean useCapture)
void	removeAbortListener(EventListener callback, EventListenerOptions options)
void	removeCompleteListener(EventListener callback)
void	removeCompleteListener(EventListener callback, boolean useCapture)
void	removeCompleteListener(EventListener callback, EventListenerOptions options)
void	removeErrorListener(EventListener callback)
void	removeErrorListener(EventListener callback, boolean useCapture)
void	removeErrorListener(EventListener callback, EventListenerOptions options)

Methods inherited from class akasha.EventTarget

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

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

onabort

@Nullable
public EventHandler onabort

In the following code snippet, we open a read/write transaction on our database and add some data to an object store. Note also the functions attached to transaction event handlers to report on the outcome of the transaction opening in the event of success or failure. Note the transaction.onabort = function(event) { }; block, reporting when the transaction has been aborted. For a full working example, see our To-do Notifications app (view example live.)

See Also:

IDBTransaction.onabort - MDN

oncomplete

@Nullable
public EventHandler oncomplete

The oncomplete event handler of the IDBTransaction interface handles the complete event, fired when the transaction successfully completes.

See Also:

IDBTransaction.oncomplete - MDN

onerror

@Nullable
public EventHandler onerror

The onerror event handler of the IDBTransaction interface handles the error event, fired when a request returns an error and bubbles up to the transaction object.

See Also:

IDBTransaction.onerror - MDN

Constructor Detail

IDBTransaction

protected IDBTransaction()

Method Detail

db

@JsProperty(name="db")
 @Nonnull
public IDBDatabase db()

An IDBDatabase object.

See Also:

IDBTransaction.db - MDN

durability

@JsProperty(name="durability")
 @Nonnull
 @IDBTransactionDurability
public java.lang.String durability()

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 exact error is one of serveral possibilities. It can be a reference to the same error as the request object that raised it, or a transaction failure (for example QuotaExceededError or UnknownError).

See Also:

IDBTransaction.error - MDN

mode

@JsProperty(name="mode")
 @Nonnull
 @IDBTransactionMode
public java.lang.String mode()

An IDBTransactionMode object defining the mode for isolating access to data in the current object stores:

See Also:

IDBTransaction.mode - MDN

objectStoreNames

@JsProperty(name="objectStoreNames")
 @Nonnull
public DOMStringList objectStoreNames()

The objectStoreNames read-only property of the IDBTransaction interface returns a DOMStringList of names of IDBObjectStore objects.

See Also:

IDBTransaction.objectStoreNames - MDN

abort

public void abort()

The abort() method of the IDBTransaction interface rolls back all the changes to objects in the database associated with this transaction.

See Also:

IDBTransaction.abort - MDN

commit

public void commit()

The commit() method of the IDBTransaction interface commits the transaction if it is called on an active transaction.

See Also:

IDBTransaction.commit - MDN

objectStore

@Nonnull
public IDBObjectStore objectStore(@Nonnull
                                           java.lang.String name)

The objectStore() method of the IDBTransaction interface returns an object store that has already been added to the scope of this transaction.

See Also:

IDBTransaction.objectStore - MDN

addAbortListener

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

addAbortListener

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

addAbortListener

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

removeAbortListener

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

removeAbortListener

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

removeAbortListener

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

addCompleteListener

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

addCompleteListener

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

addCompleteListener

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

removeCompleteListener

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

removeCompleteListener

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

removeCompleteListener

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

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)