#cordova-plugin-hotpushes
Download and cache remotely hosted content.
This plugin is a work in progress and it is not production ready. PR welcome.
cordova plugin add cordova-plugin-hotpushes
- Android
- iOS
- WP8
Parameter | Description |
---|---|
options.src |
String URL to hot push endpoint |
options.versionFileName |
String Name of the json file containing the version information |
options.type |
String (Optional) Defines the hot push strategy applied to the content.The type replace is the default behaviour that completely removes existing content then copies new content from a zip file.The type merge will download and replace only content which has changed. |
options.headers |
Object (Optional) Set of headers to use when requesting the remote content from options.src . |
options.archiveURL |
String (Mandatory if options.type === 'replace' ) URL of the zip containing the files to hot push. |
options.documentsPath |
Object (Optional) Path to the Documents folder (useful for WKWebView) |
options.versionType |
String (Optional) Set to 'package.json' if you want to use the version number in your version.json instead of timestamp |
- Instance of
HotPush
.
var hotpushes = HotPush.sync({
src: 'http://myserver/hot/',
versionFileName: 'version.json',
type: 'replace',
archiveURL: 'http://myserver/hot/assets.zip'
});
Load the local files.
Parameter | Description |
---|---|
no parameters |
Check if there is a new version available on the server.
Parameter | Description |
---|---|
no parameters |
Download the files on the server.
Parameter | Description |
---|---|
no parameters |
Parameter | Description |
---|---|
event |
String Name of the event to listen to. See below for all the event names. |
callback |
Function is called when the event is triggered. |
The event updateFound
will be triggered when a new update is found on the server.
Callback Parameter | Description |
---|---|
no parameters |
hotpushes.on('updateFound', function() {
hotpushes.update();
});
The event noUpdateFound
will be triggered when no new update is found on the server.
Callback Parameter | Description |
---|---|
no parameters |
hotpushes.on('noUpdateFound', function() {
alert('All good!');
});
The event progress
will be triggered on each update as the native platform downloads and caches the content.
Callback Parameter | Description |
---|---|
data.progress |
Integer Progress percentage between 0 - 100 . The progress includes all actions required to cache the remote content locally. This is different on each platform, but often includes requesting, downloading, and extracting the cached content along with any system cleanup tasks. |
data.status |
Integer Enumeration of PROGRESS_STATE to describe the current progress state. |
hotpushes.on('progress', function(data) {
// data.progress
// data.status
});
The event updateComplete
will be triggered when the content has been successfully cached onto the device.
Callback Parameter | Description |
---|---|
no parameters |
hotpushes.on('updateComplete', function() {
location.reload();
});
The event error
will trigger when an internal error occurs and the cache is aborted.
Callback Parameter | Description |
---|---|
e |
Error Standard JavaScript error object that describes the error. |
hotpushes.on('error', function(e) {
// e.message
});
The event cancel
will trigger when hotpushes.cancel
is called.
Callback Parameter | Description |
---|---|
no parameters |
hotpushes.on('cancel', function() {
// user cancelled the hot push
});
Cancels the content sync operation and triggers the cancel callback.
An enumeration that describes the current progress state.
Integer | Description |
---|---|
0 |
STOPPED |
1 |
DOWNLOADING |
2 |
EXTRACTING |
3 |
COMPLETE |