cordova-plugin-hotpushes v0.6.0

#cordova-plugin-hotpushes

Download and cache remotely hosted content.

This plugin is a work in progress and it is not production ready. PR welcome.

Installation

cordova plugin add cordova-plugin-hotpushes

Supported Platforms

• Android
• iOS
• WP8

Examples

• Replace example
• Merge example

API

HotPush.sync(options)

Returns

• Instance of HotPush.

Example

var hotpushes = HotPush.sync({
  src: 'http://myserver/hot/',
  versionFileName: 'version.json',
  type: Hotpush.HOTPUSH_TYPE.REPLACE,
  archiveURL: 'http://myserver/hot/assets.zip'
});

hotpushes.loadWaitingLocalFiles()

Load the local files at position -1 (see version.json).

hotpushes.loadAllLocalFiles()

Load the local files at position >= 0.

hotpushes.check()

Check if there is a new version available on the server.

hotpushes.update()

Download the files on the server.

hotpushes.on(event, callback)

hotpushes.on('updateFound', callback)

The event updateFound will be triggered when a new update is found on the server.

Example

hotpushes.on('updateFound', function() {
  hotpushes.update();
});

hotpushes.on('noUpdateFound', callback)

The event noUpdateFound will be triggered when no new update is found on the server.

Example

hotpushes.on('noUpdateFound', function() {
  alert('All good!');
});

hotpushes.on('progress', callback)

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

Example

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

hotpushes.on('updateComplete', callback)

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

Example

hotpushes.on('updateComplete', function() {
  location.reload();
});

hotpushes.on('error', callback)

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

Example

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

hotpushes.on('cancel', callback)

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

Example

hotpushes.on('cancel', function() {
    // user cancelled the hot push
});

hotpushes.cancel()

Cancels the content sync operation and triggers the cancel callback.

HotPush.PROGRESS_STATE

An enumeration that describes the current progress state.

HotPush.HOTPUSH_TYPE

An enumeration that describes the type of hotpush to perform.

HotPush.HOTPUSH_CHECK_TYPE

An enumeration that describes the field to look at in the version.json file.