Skip to content

Latest commit

 

History

History
118 lines (92 loc) · 4.98 KB

README.md

File metadata and controls

118 lines (92 loc) · 4.98 KB
Raw

Google Chrome background messaging API Storage Adapter

A storage adapter for Google Chrome web browser extension writers that treats the background page as a storage backend.

Designed to optionally be used with the backbone.storageProxy.js plugin.

Usage

<script src="backbone.js"></script>
<script src="backbone.chromeBackgroundPageStorageAdapter.js"></script>

To send data to the background page for later storage (e.g. using the chrome storage APIs):

var model = Backbone.Model.extend({
     backgroundPageStorage: new Backbone.ChromeBackgroundPageStorageAdapter(),

     sync: function(method, model, options)
     {
         return this.backgroundPageStorage.sync(method, model, options);
     }
});

To use alongside backbone.storageProxy.js:

var model = Backbone.Model.extend({
    initialize: function()
    {
        this.storageProxy = new Backbone.StorageProxy(this, new Backbone.ChromeBackgroundPageStorageAdapter();
    }
});

Any subsequent call to the sync method on a model or collection with the storage adapter applied will have its data sent to the background page for storage. As the save, fetch or destroy methods forward to the sync method associated to their respective model or collection, those calls will also be handled by the storage adapter and thus the background page.

Background page

The background page must register an event handler to receive messages via a callback. For example:

function onMessageCallback(request, sender, sendResponse) {
    switch (request.method) {
        case 'readBackboneCollection':
            // ... do something to fetch the data and populate the
            // sendResponse object with the items key
            // e.g. sendResponse({records: [{id: 1, name: 'Jim'}, {id: 2, name: 'Bob'}]});
            break;

        case 'readBackboneRecord':
            // ... do something to fetch the data and populate the
            // sendResponse object with the items key
            // e.g. sendResponse({records: {id: 1, name: 'Jim'}});
            break;

        case 'createBackboneRecord':
            // ... do something to create the record. Make sure to populate
            // the sendResponse object with an id attribute.
            // e.g. sendResponse({records: {id: 1}});
            break;

        case 'updateBackboneRecord':
            // ... do something to update the record, no need to
            // e.g. sendResponse({}); // return any data here
            break;

        case 'deleteBackboneRecord':
            // ... do something to delete the record, no need to
            // e.g. sendResponse({}); // return any data here
            break;
    }
}

chrome.runtime.onMessage.addListener(onMessageCallback);

Object key names

You can change the key names and values used in the request object passed to background page by defining the keys to use when attaching an instance of the ChromeBackgroundPageStorageAdapter class to your models and collections.

To do this, specify the correct options in the operations parameter passed to the constructor of ChromeBackgroundPageStorageAdapter.

Options

Options are:

  • keyName - Key name passed in the request that will contain the individual action name to be performed.
  • createRecordKey - The model create record action name, as set as a value in the keyName option attribute when requesting the creation of a new record from the background page.
  • readRecordKey - The model read record action name, as set as a value in the keyName option attribute when requesting the read of an existing record from the background page.
  • updateRecordKey - The update record action name, as set as a value in the keyName option attribute when requesting the update of an existing record from the background page.
  • deleteRecordKey - The delete record action name, as set as a value in the keyName option attribute when requesting the deletion of an existing record from the background page.
  • readCollectionKey - The collection read records action name, as set as a value in the KeyName option attribute when requesting the read of existing records from the background page.
  • reqKeyName - The key name used in all requests when passing records to the background page.
  • respKeyName - The key name to expect in all responses passed back from the background page that will contain any data for records returned.
  • extraAttributes - An object of any extra static data that should be sent in the request.

License

Copyright 2013 Simon Paulger [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.