Flexberry Documentation Flexberry Documentation

  • API Docs for Version: master

    • APIs

    Show:

    Offline Class

    Extends DS.Adapter
    Defined in: addon/serializers/offline.js:11
    Module: ember-flexberry-data

    Base serializer for Offline.LocalStore.

    Methods

    _deleteDetailModels

    (
    • dexieService
    • db
    • promises
    • record
    )
    private

    Defined in addon/adapters/offline.js:605

    Forming promises for deleting current record and its details.

    Parameters:

    • dexieService Offline.DexieService

      Instance of dexie service.

    • db IndexedDB

      Instance of current IndexedDB database.

    • promises Promise

      Promises on deleting records.

    • record DS.Model

      Current record that should be deleted with details.

    _extractProjectionFromQuery

    (
    • modelName
    • typeClass
    • [query]
    )
    Object private

    Defined in addon/adapters/offline.js:534

    Retrieves projection from query and returns it. Retrieved projection removes from the query.

    Parameters:

    • modelName String

      The name of the model type.

    • typeClass subclass of DS.Model

      Model type.

    • [query] Object optional

      Query parameters.

      • [projection] String optional

        Projection name.

    Returns:

    Object:

    Extracted projection from query or null if projection is not set in query.

    _makeQueryObject

    (
    • store
    • modelName
    • query
    • [projection]
    )
    QueryObject private

    Defined in addon/adapters/offline.js:483

    Makes Query.QueryObject out of queries that look like this: { : , ... }.

    Parameters:

    • store Object

      Store used for making query

    • modelName String

      The name of the model type.

    • query Object

      Query parameters.

    • [projection] Object | String optional

      Projection for query.

    Returns:

    QueryObject:

    Query object for IndexedDB adapter.

    _storeHashForBulkOperation

    (
    • modelName
    • hash
    )
    private

    Defined in addon/adapters/offline.js:465

    Stores hash for performing bulk operaion into map.

    Parameters:

    addHashForBulkUpdateOrCreate

    (
    • store
    • type
    • snapshot
    • fieldsToUpdate
    • syncDownTime
    )
    Promise

    Defined in addon/adapters/offline.js:328

    Stores record's hash for performing bulk operaion with {{#crossLink "Adapter.Offline/bulkUpdateOrCreate:method"}} method.

    Parameters:

    Returns:

    Promise:

    batchSelect

    (
    • store
    • queries
    )
    Promise

    Defined in addon/adapters/offline.js:452

    A method to get array of models.

    Parameters:

    • store DS.Store

      The store.

    • queries Query

      Array of Flexberry Query objects.

    Returns:

    Promise:

    A promise that fulfilled with an array of query responses.

    batchUpdate

    ()

    Defined in addon/adapters/offline.js:443

    This method is not implemented.

    bulkUpdateOrCreate

    (
    • store
    • replaceIfExist
    • clearHashesOnTransactionFail
    )
    Promise

    Defined in addon/adapters/offline.js:392

    Performing bulk operaion with previously stored hashes.

    Parameters:

    • store DS.Store
    • replaceIfExist Boolean

      If set to true then hashes will be replaced in store if they already exist

    • clearHashesOnTransactionFail Boolean

      If set to true then previously stored hashes will be cleared if transaction with bulk operations fails

    Returns:

    Promise:

    clear

    (
    • [table]
    )
    Promise

    Defined in addon/adapters/offline.js:74

    Clear tables in IndexedDB database, if table not specified, clear all tables.

    Parameters:

    • [table] String optional

      Table name.

    Returns:

    Promise:

    createRecord

    (
    • store
    • type
    • snapshot
    )
    Promise

    Defined in addon/adapters/offline.js:209

    Implement this method in a subclass to handle the creation of new records. More info.

    Parameters:

    Returns:

    Promise:

    delete

    () Promise

    Defined in addon/adapters/offline.js:92

    Delete IndexedDB database.

    Returns:

    Promise:

    deleteRecord

    (
    • store
    • type
    • snapshot
    )
    Promise

    Defined in addon/adapters/offline.js:259

    Implement this method in a subclass to handle the deletion of a record. More info.

    Parameters:

    Returns:

    Promise:

    extractAttributes

    (
    • model
    • hash
    )
    Object

    Defined in addon/serializers/offline.js:28

    Returns the resource's attributes formatted as a JSON-API "attributes object". More info.

    Parameters:

    Returns:

    Object:

    findAll

    (
    • store
    • type
    )
    Promise

    Defined in addon/adapters/offline.js:118

    The findAll() method is used to retrieve all records for a given type. More info.

    Parameters:

    Returns:

    Promise:

    findMany

    (
    • store
    • type
    • ids
    )
    Promise

    Defined in addon/adapters/offline.js:133

    Find multiple records at once if coalesceFindRequests is true. More info.

    Parameters:

    Returns:

    Promise:

    findRecord

    (
    • store
    • type
    • id
    )
    Promise

    Defined in addon/adapters/offline.js:102

    The findRecord() method is invoked when the store is asked for a record that has not previously been loaded. More info.

    Parameters:

    Returns:

    Promise:

    generateIdForRecord

    (
    • store
    • type
    • inputProperties
    )
    String

    Defined in addon/adapters/offline.js:63

    Generate globally unique IDs for records.

    Parameters:

    Returns:

    String:

    normalizeArrayResponse

    (
    • store
    • type
    • payload
    )
    Object

    Defined in addon/serializers/offline.js:125

    Normalization method for arrays of objects. More info.

    Parameters:

    Returns:

    Object:

    query

    (
    • store
    • type
    • query
    )
    Promise

    Defined in addon/adapters/offline.js:171

    This method is called when you call query on the store. More info.

    Supports Query.QueryObject instance or objects that look like this:

    {
                      ...
                      <property to query>: <value to match>,
                      //and
                      <property to query>: <value to match>,
                      ...
                    }

    Parameters:

    Returns:

    Promise:

    queryRecord

    (
    • store
    • type
    • query
    )
    Promise

    Defined in addon/adapters/offline.js:157

    The queryRecord() method is invoked when the store is asked for a single record through a query object. More info.

    Parameters:

    Returns:

    Promise:

    serializeAttribute

    (
    • snapshot
    • json
    • key
    • attribute
    )

    Defined in addon/serializers/offline.js:51

    Method serializeAttribute can be used to customize how DS.attr properties are serialized. More info.

    Parameters:

    updateOrCreate

    (
    • store
    • type
    • snapshot
    • fieldsToUpdate
    )
    Promise

    Defined in addon/adapters/offline.js:290

    Create record if it does not exist, or update changed fields of record.

    Parameters:

    Returns:

    Promise:

    updateRecord

    (
    • store
    • type
    • snapshot
    )
    Promise

    Defined in addon/adapters/offline.js:234

    Implement this method in a subclass to handle the updating of a record. More info.

    Parameters:

    Returns:

    Promise:

    Properties

    dbName

    String

    Defined in addon/adapters/offline.js:46

    Database name for IndexedDB.

    Default: 'ember-flexberry-data'

    defaultSerializer

    String

    Defined in addon/adapters/offline.js:36

    If you would like your adapter to use a custom serializer you can set the defaultSerializer property to be the name of the custom serializer. More info.

    Default: 'offline'

    dexieService

    Offline.DexieService

    Defined in addon/adapters/offline.js:55

    Instance of dexie service.