Flexberry Documentation Flexberry Documentation

  • API Docs for Version: master

    • APIs

    Show:

    LocalStore Class

    Extends DS.Store
    Defined in: addon/stores/local-store.js:15
    Module: ember-flexberry-data

    Store that used in offline mode by default.

    Methods

    adapterFor

    (
    • modelName
    )
    public

    Defined in addon/stores/local-store.js:73

    Returns an instance of the adapter for a given type. Offline adapters should have name with postfix '-offline'.

    Parameters:

    • modelName String

      The name of the model type.

    batchUpdate

    (
    • models
    )
    Promise

    Defined in addon/stores/local-store.js:235

    Calls the save method on each passed model and returns a promise that is resolved by an array of saved models.

    The array which fulfilled the promise may contain the following values:

    • same model object - for created, updated or unaltered records.
    • null - for deleted records.

    Parameters:

    Returns:

    Promise:

    A promise that fulfilled with an array of models in the new state.

    deleteRecord

    (
    • modelName
    • filter
    )

    Defined in addon/stores/local-store.js:220

    Delete all record from the current store.

    Parameters:

    findAll

    (
    • modelName
    • [options]
    )
    DS.AdapterPopulatedRecordArray public

    Defined in addon/stores/local-store.js:94

    Finds the records for the given model type.

    See findAll for details.

    Parameters:

    • modelName String

      The name of the model type.

    • [options] Object optional

      Options.

      • projection String

        Projection name.

    Returns:

    DS.AdapterPopulatedRecordArray:

    Records promise.

    findRecord

    (
    • modelName
    • id
    • [options]
    )
    Promise public

    Defined in addon/stores/local-store.js:125

    Returns a record for a given type and id combination.

    See findRecord for details.

    Parameters:

    • modelName String

      The name of the model type.

    • id String | Integer

      Record ID.

    • [options] Object optional

      Options.

      • projection String

        Projection name.

    Returns:

    Promise:

    Record promise.

    init

    ()

    Defined in addon/stores/local-store.js:39

    Initializing instance. More info.

    query

    (
    • modelName
    • query
    )
    Promise public

    Defined in addon/stores/local-store.js:158

    This method delegates a query to the adapter.

    See query for details.

    Parameters:

    • modelName String

      The name of the model type.

    • query Object

      An opaque query to be used by the adapter.

      • [projection] String optional

        Projection name.

    Returns:

    Promise:

    A promise, which is resolved with a RecordArray once the server returns.

    queryRecord

    (
    • modelName
    • query
    )
    Promise public

    Defined in addon/stores/local-store.js:190

    This method delegates a query to the adapter.

    See queryRecord for details.

    Parameters:

    • modelName String

      The name of the model type.

    • query Object

      An opaque query to be used by the adapter.

      • [projection] String optional

        Projection name.

    Returns:

    Promise:

    A promise, which is resolved with a DS.RecordObject once the server returns.

    serializerFor

    (
    • modelName
    )
    public

    Defined in addon/stores/local-store.js:52

    Returns an instance of the serializer for a given type. Offline serializers should have name with postfix '-offline'.

    Parameters:

    • modelName String

      The name of the model type.

    Properties

    dbName

    String

    Defined in addon/stores/local-store.js:23

    Database name for IndexedDB.

    Default: 'ember-flexberry-data'