#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

new HotPush(options)

Returns

• Instance of HotPush.

Example

var hotpushes = new HotPush({
  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). Return a promise.

Example

hotpushes.loadWaitingLocalFiles()
  .then((result) => console.log('waiting'))
  .catch((err) => console.log(err));

hotpushes.loadLocalFiles()

Load the local files at position >= 0. Return a promise.

Example

hotpushes.loadLocalFiles()
  .then((result) => console.log('all good'))
  .catch((err) => console.log(err));

hotpushes.check()

Check if there is a new version available on the server. Return a promise which resolve with either HotPush.UPDATE.FOUND or HotPush.UPDATE.NOT_FOUND.

Example

hotpushes.check()
  .then((result) => {
    if (result === HotPush.UPDATE.FOUND) {
      // do something. Maybe hotpushes.update() or show a popup ?
    }
  })
  .catch((err) => console.log(err));

hotpushes.update()

Download the files on the server. Return a promise.

Example

hotpushes.update()
  .then(() => {
    location.reload();
  })
  .catch((err) => console.log(err));

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.cancel()

Cancels the content sync operation.

hotpushes.lastCheck

Timestamp of the last check

hotpushes.lastUpdate

Timestamp of the last update

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.

HotPush.UPDATE