Cordova diagnostic plugin

• Overview
• Installation
• Usage
• Credits

Overview

This Cordova/Phonegap plugin is used to check Location/WiFi/Camera device settings.

The plugin currently supports the iOS and Android platforms.

The plugin is registered in the the Cordova Registry(Cordova 3/4) and npmjs.com (Cordova 5+).

Installation

Using the Cordova/Phonegap CLI

$ cordova plugin add cordova.plugins.diagnostic
$ phonegap plugin add cordova.plugins.diagnostic

Using Cordova Plugman

$ plugman install --plugin=cordova.plugins.diagnostic --platform=<platform> --project=<project_path> --plugins_dir=plugins

For example, to install for the Android platform

$ plugman install --plugin=cordova.plugins.diagnostic --platform=android --project=platforms/android --plugins_dir=plugins

PhoneGap Build

Add the following xml to your config.xml to use the latest version of this plugin from the Cordova Registry:

<gap:plugin name="cordova.plugins.diagnostic" source="plugins.cordova.io" />

or from npmjs.com:

<gap:plugin name="cordova.plugins.diagnostic" source="npm" />

Usage

The plugin is exposed via the cordova.plugins.diagnostic object and provides the following functions:

• isLocationEnabled()
• isLocationEnabledSetting()
• isLocationAuthorized()
• switchToLocationSettings()
• isWifiEnabled()
• isCameraEnabled()

isLocationEnabled()

Checks if app is able to access location. On iOS this returns true if both the device setting for location is on and the application is authorized to use location. On Android this returns true if location setting is set to High Precision (GPS).

cordova.plugins.diagnostic.isLocationEnabled(successCallback, errorCallback);

Parameters

• {function} successCallback - The callback which will be called when diagnostic of location is successful. This callback function have a boolean param with the diagnostic result.
• {function} errorCallback - The callback which will be called when diagnostic of location encounters an error. This callback function have a string param with the error.

Example usage

cordova.plugins.diagnostic.isLocationEnabled(function(enabled){
    console.log("Location is " + (enabled ? "enabled" : "disabled"));
}, function(error){
    console.error("The following error occurred: "+error);
});

isLocationEnabledSetting()

Checks if location setting is enabled on device. On iOS this returns true if both the device setting for location is on. On Android this returns true if location setting is set to High Precision (GPS).

cordova.plugins.diagnostic.isLocationEnabledSetting(successCallback, errorCallback);

Parameters

• {function} successCallback - The callback which will be called when diagnostic of location setting is successful. This callback function have a boolean param with the diagnostic result.
• {function} errorCallback - The callback which will be called when diagnostic of location setting encounters an error. This callback function have a string param with the error.

Example usage

cordova.plugins.diagnostic.isLocationEnabledSetting(function(enabled){
    console.log("Location setting is " + (enabled ? "enabled" : "disabled"));
}, function(error){
    console.error("The following error occurred: "+error);
});

isLocationAuthorized()

Checks if app is authorised to use location. On iOS this returns true if the application is authorized to use location. On Android this returns true if location setting is set to High Precision (GPS).

cordova.plugins.diagnostic.isLocationAuthorized(successCallback, errorCallback);

Parameters

• {function} successCallback - The callback which will be called when diagnostic of location authorization is successful. This callback function have a boolean param with the diagnostic result.
• {function} errorCallback - The callback which will be called when diagnostic of location authorization encounters an error. This callback function have a string param with the error.

Example usage

cordova.plugins.diagnostic.isLocationAuthorized(function(enabled){
    console.log("Location authorization is " + (enabled ? "enabled" : "disabled"));
}, function(error){
    console.error("The following error occurred: "+error);
});

switchToLocationSettings()

Android only: displays the device location settings to allow user to enable location services.

cordova.plugins.diagnostic.switchToLocationSettings();

Example usage

cordova.plugins.diagnostic.isLocationEnabled(function(enabled){
    if(!enabled{
        cordova.plugins.diagnostic.switchToLocationSettings();
    }
}, function(error){
    console.error("The following error occurred: "+error);
});

isWifiEnabled()

Checks if Wifi is connected/enabled. On iOS this returns true if the device is connected to a network by WiFi. On Android this returns true if the WiFi setting is set to enabled.

cordova.plugins.diagnostic.isWifiEnabled(successCallback, errorCallback);

Parameters

• {function} successCallback - The callback which will be called when diagnostic of Wi-Fi is successful. This callback function have a boolean param with the diagnostic result.
• {function} errorCallback - The callback which will be called when diagnostic of Wi-Fi encounters an error. This callback function have a string param with the error.

Example usage

cordova.plugins.diagnostic.isWifiEnabled(function(enabled){
    console.log("WiFi is " + (enabled ? "enabled" : "disabled"));
}, function(error){
    console.error("The following error occurred: "+error);
});

isCameraEnabled()

Checks if the device has a camera (same on Android and iOS)

cordova.plugins.diagnostic.isCameraEnabled(successCallback, errorCallback);

Parameters

• {function} successCallback - The callback which will be called when diagnostic of camera is successful. This callback function have a boolean param with the diagnostic result.
• {function} errorCallback - The callback which will be called when diagnostic of camera encounters an error. This callback function have a string param with the error.

Example usage

cordova.plugins.diagnostic.isCameraEnabled(function(exists){
    console.log("Device " + (exists ? "does" : "does not") + " have a camera");
}, function(error){
    console.error("The following error occurred: "+error);
});

Credits

Forked from: https://github.com/mablack/cordova-diagnostic-plugin

Orignal Cordova 2 implementation by: AVANTIC ESTUDIO DE INGENIEROS (www.avantic.net)