Apache Cordova Appaloosa Plugin

This is a plugin to allow you to use Appaloosa iOS and Android SDK

Please refer to the official repository to have more information

Prerequisites

• Android 4.0.3+ (API lvl 15)
• An Enterprise account on Appaloosa Store
• A native store must have been created for your account
• At least one login on the native store

Supported Platforms

• Android
• iOS

Installation

cordova plugin add cordova-plugin-appaloosa

Utilisation

When the plugin will be added in the app, you can access to the APIs in window.Appaloosa object. A sample is available on this repo HAVE TO BE UPDATED!!

###Initialization Add the following line at the start of your application

 Appaloosa.initialisation(YOUR_APPALOOSA_STORE_ID, YOUR_APPALOOSA_STORE_TOKEN, functionOnSucess,functionOnError);

###Authorization This library provides an app authorization mechanism. Via Appaloosa web admin on https://www.appaloosa-store.com, you can manage a per device access. It works by sending device information to the Appaloosa servers. In case of an offline access to your app, the status is read from a protected file on the device.

 Appaloosa.authorization(functionOnSuccess,functionOnError);

The twice function have status in parameters. Use it and the Appaloosa.status to compare return value.

####Appaloosa status available:

• UNKNOWN_APPLICATION*
• AUTHORIZED
• UNREGISTERED_DEVICE
• UNKNOWN_DEVICE
• NOT_AUTHORIZED
• DEVICE_ID_FORMAT_ERROR*
• NO_NETWORK
• REQUEST_ERROR
• UNKNOWN

*Can not be returned because not exist on iOS

###Analytics

To record analytics on your app usage, simply add the following line at the start of your application. Be careful to be authorized before with Appaloosa.authorization function.

 Appaloosa.startAnalytics(functionOnSuccess,functionOnError);

###Auto-Update This library allows you to encourage updates by forcing the download of the new update when the application starts. Simply add the following line to your code :

 Appaloosa.autoUpdate(functionOnSuccess,functionOnError);

On iOS, the functionOnSuccess return a OTAppaloosaUpdateStatus, which can be:

• DEVICE_ID_FORMAT_ERROR
• UNREGISTERED_DEVICE
• UNKNOWN_APPLICATION
• UPDATE_NEEDED
• UPDATE_NOT_NEEDED

If update is required, you can call this following line to download the new version.

Appaloosa.downloadNewVersion(functionOnSuccess,functionOnError);

On Android, autoUpdate function will appear an Alert view if update is required. If your prefer to leave the choice to the user to download or not the update, the following method will suit your needs :

 Appaloosa.autoUpdateWithMessage(title, message, functionOnSuccess,functionOnError);

iOS

###Add the dev panel to your app The Appaloosa's SDK also provides a dev panel which gives information about the device and the application. To use it call:

 Appaloosa.devPanelWithDefaultButtonAtPosition(position, functionOnSucess,functionOnError);

In order to set the button on the right side at the bottom, or on the bottom side on the right, replace position variable with "rightBottom" for the first position or "bottomRight" for the second.

If you prefer using your own button/action to trigger the dev panel, you can use the following line in your onClick:

 Appaloosa.openDevPanelController(functionOnSucess,functionOnError);

Think to init with Appaloosa.initialisation function before call it.

###Add in-app-feedback to your app

The Appaloosa's SDK provides a fully integrated solution to send feedback to your dev team. To use it add the following line:

 Appaloosa.feedbackControllerWithDefaultButtonAtPosition(position, emails, functionOnSuccess,functionOnError);

In order to set the button on the right side at the bottom, or on the bottom side on the right, replace position variable with "rightBottom" for the first position or "bottomRight" for the second.

The emails variable has to be a string separated with a comma like it: "[email protected],[email protected]". If uncessary, set null.

If you prefer using your own button/action to trigger the dev panel, you can use the following line in your onClick:

 Appaloosa.openFeedbackControllerWithRecipientsEmailArray(emails, functionOnSuccess,functionOnError);

Example

angular.module('starter.service', [])
    .factory('AppaloosaService', function ($log) {

    var _Appaloosa;
    var _isInitialized = false;
	var isAuthorized = false;

    function init(appaloosaStoreId, appaloosaStoreToken) {

        if (window.Appaloosa) {

            _Appaloosa = window.Appaloosa;

            _Appaloosa.initialisation(appaloosaStoreId, appaloosaStoreToken,
            function(msg){
                console.log(msg);
                _isInitialized = true;
                 _isAuthorized = true;
                checkAuthorization();
            },
            function(){
                console.log("Initialisation error");
            });
        } else {
            $log.info('Appaloosa is undefined');
        }
    }

	function checkAuthorization(){
       if(_isInitialized){
           _Appaloosa.authorization(function (status){
                   console.log("status: " + status);
                   _isAuthorized = true;
                   autoUpdate();
               },
               function (errorMessage){
                   console.log("Unauthorized: " + errorMessage);
               })
       }
    }

	function autoUpdate(){

        if(_isInitialized && _isAuthorized){
	        devPanelWithDefaultButtonAtPosition("bottomRight");  
	        
            _Appaloosa.autoUpdate(function (status) {
                
                if(status === _Appaloosa.updateStatus.UPDATE_NEEDED){
                    _Appaloosa.downloadNewVersion(function(){
                        console.log("Downloading... Done");
                    },
                    function(error){
                        console.log(error);
                    });
                }

            }, function (errorMsg) {
                console.warning("error: " + errorMsg);
            });
        }
        else{
            $log.info('Veuillez vérifier vos autorisations');
        }
    }