Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 3.52 KB

README.md

File metadata and controls

92 lines (58 loc) · 3.52 KB
Raw

AppIT Ionic Cordova SDK

Supported platforms: iOS, Android

Platform

https://ionpush.appit-online.de/

Platform Docs

https://ionpush.appit-online.de/#/docs

Setup

cordova plugin add https://github.com/appit-online/appit-ionic-plugin.git --save --variable APP_ID="REPLACE_WITH_APP_IDENTIFIER" --variable CHANNEL_NAME="Production" --variable UPDATE_METHOD="background" --variable UPDATE_API="https://build.appit-online.de" --variable WARN_DEBUG="false"

The plugin will be available on window as IonicCordova

NOTE: The plugin delays the cordova ready event until it finish checking for updates and add this preference to the app <preference name="AutoHideSplashScreen" value="false"/>, which makes the Splash Screen to not go away automatically. All Ionic templates run this.splashScreen.hide(); on cordova ready event, but if it was removed it should be added back. Alternatively the app can add <preference name="AutoHideSplashScreen" value="true"/> to override the value added by the plugin, but that can lead to the Splash Screen going away before the download is complete.

Build sources

If you like to build the sources manually, run the follwoing commands:

npm install
npm run build

Live Updates

Cordova Install Variables

  • APP_ID Required - Your app Identifier from https://ionpush.appit-online.de/
  • CHANNEL_NAME Required - The channel to check for updates from -> e.g. Production
  • UPDATE_API - The location of the API -> use https://build.appit-online.de
  • UPDATE_METHOD - auto, background, or none. Dictates the behavior of the plugin. auto will download and apply the latest update on app start, potentially leading to long splash screen loads if the connection is slow. background will only download the update in the background on app start, but will allow full functionality while doing so, only redirecting users the next time the app is loaded. none will do nothing, leaving full plugin functionality in the hands of the developer. Default is background
  • MAX_STORE - The maximum number of downloaded versions to store on the device for quick loading. More versions means less downloading, but can increase the app size greatly. Default is 3 (Defaults is 2 in V5)
  • MIN_BACKGROUND_DURATION - The minimum duration in seconds after which the app in background checks for an update. Default is 30 (New in V5)

Preferences

  • DisableDeploy - Default value is false.

Allows to disable deploy updates by adding this preference in the config.xml

<preference name="DisableDeploy" value="true" />

API Docs

External modules

Contributing to this plugin

npm install
npm run create-dev

This will create a blank Ionic app in a local tmp directory with the plugin and dependencies installed, and the iOS platform added. Native plugin code is installed with --link and any changes to the typescript in www will be copied over into the app's platforms/ios and platforms/android directories.

Some other helpful dev commands

npm run apply-dev

Updates the linked plugin in the tmp test app with your JavaScript changes

npm run watch

Watches for Typescript changes

npm run watch-dev

Watches for Typescript changes, then runs the apply-dev script to propogate them to the testing app.

Forked by: https://github.com/ionic-team/cordova-plugin-ionic (MIT License)