armingal / wink-phonegap-conentsync Goto Github PK

#phonegap-plugin-contentsync

Download and cache remotely hosted content.

phonegap plugin add https://github.com/phonegap/phonegap-plugin-contentsync

• Android
• iOS
• WP8

var sync = ContentSync.sync({ src: 'http://myserver/assets/movie-1', id: 'movie-1' });

sync.on('progress', function(data) {
    // data.progress
});

sync.on('complete', function(data) {
    // data.localPath
});

sync.on('error', function(e) {
    // e.message
});

sync.on('cancel', function() {
    // triggered if event is cancelled
});

• Instance of ContentSync.

var sync = ContentSync.sync({ src: 'http://myserver/app/1', id: 'app-1' });

The event progress will be triggered on each update as the native platform downloads and caches the content.

sync.on('progress', function(data) {
    // data.progress
    // data.status
});

The event complete will be triggered when the content has been successfully cached onto the device.

sync.on('complete', function(data) {
    // data.localPath
    // data.cached
});

The event error will trigger when an internal error occurs and the cache is aborted.

sync.on('error', function(e) {
    // e.message
});

The event cancel will trigger when sync.cancel is called.

sync.on('cancel', function() {
    // user cancelled the sync operation
});

Cancels the content sync operation and triggers the cancel callback.

var sync = ContentSync.sync({ src: 'http://myserver/app/1', id: 'app-1' });

sync.on('cancel', function() {
    console.log('content sync was cancelled');
});

sync.cancel();

An enumeration that describes the current progress state. The mapped String values can be customized for the user's app.

If you are using the Chromium Zip plugin this plugin won't work for you on iOS. However, it supports the same interface so you don't have to install both.

zip.unzip(<source zip>, <destination dir>, <callback>, [<progressCallback>]);

There is also an extra convenience method that can be used to download an archive

ContentSync.download(url, headers, cb)

The progress events described above also apply for these methods.

ContentSync.PROGRESS_STATE[1] = 'Downloading the media content...';

• There should be no dependency on the existing File or FileTransfer plugins.
• The native cached file path should be uniquely identifiable with the id parameter. This will allow the Content Sync plugin to lookup the file path at a later time using the id parameter.
• The first version of the plugin assumes that all cached content is downloaded as a compressed ZIP. The native implementation must properly extract content and clean up any temporary files, such as the downloaded zip.
• The locally compiled Cordova web assets should be copied to the cached content. This includes cordova.js, cordova_plugins.js, and plugins/**/*.
• Multiple syncs should be supported at the same time.

npm test

The project uses .editorconfig to define the coding style of each file. We recommend that you install the Editor Config extension for your preferred IDE.

The project uses .jshint to define the JavaScript coding conventions. Most editors now have a JSHint add-on to provide on-save or on-edit linting.

1. Install jshint.
2. Install jshint.vim.

1. Install Package Control
2. Restart Sublime
3. Type CMD+SHIFT+P
4. Type Install Package
5. Type JSHint Gutter
6. Sublime -> Preferences -> Package Settings -> JSHint Gutter
7. Set lint_on_load and lint_on_save to true