com.vaadin.polymer.app.AppPouchDBDatabaseBehavior Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-gwt-polymer-elements Show documentation
vaadin-gwt-polymer-elements
The newest version!
/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from app-pouchdb project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.app;

import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;


/**
 * Polymer.AppPouchDBDatabaseBehavior is an abstract implementation that
is intended to be shared by any element that refers to and operates on a
PouchDB database instance. It includes implementation for creating and
configuring a PouchDB database instance, and some advanced macro
operations that might be performed on the database, including “upsert”
and conflict-aware “put” and “post” operations.
 */
@JsType(isNative=true)
public interface AppPouchDBDatabaseBehavior {

    @JsOverlay public static final String NAME = "Polymer.AppPouchDBDatabaseBehavior";
    @JsOverlay public static final String SRC = "app-pouchdb/app-pouchdb-query.html";


    /**
     * A reference to the PouchDB database instance that has been created.
     *
     * JavaScript Info:
     * @property db
     * @type Object
     * 
     */
    @JsProperty JavaScriptObject getDb();
    /**
     * A reference to the PouchDB database instance that has been created.
     *
     * JavaScript Info:
     * @property db
     * @type Object
     * 
     */
    @JsProperty void setDb(JavaScriptObject value);

    /**
     * If desired, assign a function that implements a conflict resolution
strategy. This conflict resolution strategy will take precedence when
a conflict occurs, and will prevent conflict notification events from
being fired.
     * Consider using an app-pouchdb-conflict-resolver element instead for
a more declarative experience!
     *
     * JavaScript Info:
     * @property resolveConflict
     * @type Function
     * 
     */
    @JsProperty Function getResolveConflict();
    /**
     * If desired, assign a function that implements a conflict resolution
strategy. This conflict resolution strategy will take precedence when
a conflict occurs, and will prevent conflict notification events from
being fired.
     * Consider using an app-pouchdb-conflict-resolver element instead for
a more declarative experience!
     *
     * JavaScript Info:
     * @property resolveConflict
     * @type Function
     * 
     */
    @JsProperty void setResolveConflict(Function value);

    /**
     * The number of document revisions to keep track of. The default value
(0) indicates no limit.
     *
     * JavaScript Info:
     * @property revsLimit
     * @type Number
     * 
     */
    @JsProperty double getRevsLimit();
    /**
     * The number of document revisions to keep track of. The default value
(0) indicates no limit.
     *
     * JavaScript Info:
     * @property revsLimit
     * @type Number
     * 
     */
    @JsProperty void setRevsLimit(double value);

    /**
     * If true, all attempts to “put” or “post” values into the database
will be automatically structured as an “upsert”, where documents are
updated if already available, or created if not.
     *
     * JavaScript Info:
     * @property upsert
     * @type Boolean
     * 
     */
    @JsProperty boolean getUpsert();
    /**
     * If true, all attempts to “put” or “post” values into the database
will be automatically structured as an “upsert”, where documents are
updated if already available, or created if not.
     *
     * JavaScript Info:
     * @property upsert
     * @type Boolean
     * 
     */
    @JsProperty void setUpsert(boolean value);

    /**
     * The PouchDB adapter to use. For more information on PouchDB adapters,
please refer to the PouchDB documentation
here.
     *
     * JavaScript Info:
     * @property adapter
     * @type String
     * 
     */
    @JsProperty String getAdapter();
    /**
     * The PouchDB adapter to use. For more information on PouchDB adapters,
please refer to the PouchDB documentation
here.
     *
     * JavaScript Info:
     * @property adapter
     * @type String
     * 
     */
    @JsProperty void setAdapter(String value);

    /**
     * The name of the database. This can be either a local database (such
as “cats”), or a remote one (e.g., “https://example.com:5678/cats“).
     *
     * JavaScript Info:
     * @property dbName
     * @type String
     * 
     */
    @JsProperty String getDbName();
    /**
     * The name of the database. This can be either a local database (such
as “cats”), or a remote one (e.g., “https://example.com:5678/cats“).
     *
     * JavaScript Info:
     * @property dbName
     * @type String
     * 
     */
    @JsProperty void setDbName(String value);


}