Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
cordova-plugin-hotspot
Advanced tools
cordova-plugin-hotspot - npm Package Compare versions
Comparing version 0.8.0 to 0.8.1
| { | ||
| "name": "cordova-plugin-hotspot", | ||
| "version": "0.8.0", | ||
| "version": "0.8.1", | ||
| "description": "Cordova WiFi Hotspot Plugin", | ||
@@ -5,0 +5,0 @@ "cordova": { |
@@ -12,3 +12,6 @@ <a name="cordova.plugins.hotspot"></a> | ||
| * [.stopHotspot(successCB, errorCB)](#cordova.plugins.hotspot+stopHotspot) | ||
| * [.isHotspotEnabled(enabledCB, disabledCB)](#cordova.plugins.hotspot+isHotspotEnabled) | ||
| * [.getAllHotspotDevices(successCB, errorCB)](#cordova.plugins.hotspot+getAllHotspotDevices) | ||
| * [.connectToHotspot(ssid, password, successCB, errorCB)](#cordova.plugins.hotspot+connectToHotspot) | ||
| * [.connectToWifiAuthEncrypt(ssid, password, authentication, encryption, successCB, errorCB)](#cordova.plugins.hotspot+connectToWifiAuthEncrypt) | ||
| * [.configureHotspot(ssid, mode, password, successCB, errorCB)](#cordova.plugins.hotspot+configureHotspot) | ||
@@ -63,5 +66,5 @@ * [.addWifiNetwork(ssid, mode, password, successCB, errorCB)](#cordova.plugins.hotspot+addWifiNetwork) | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | mode | <code>String</code> | wireless mode (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>String</code> | password to use | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | mode | <code>string</code> | wireless mode (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>string</code> | password to use | | ||
| | successCB | <code>function</code> | A callback function to be called when start was successful | | ||
@@ -89,5 +92,5 @@ | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | mode | <code>String</code> | wireless mode (Open, WEP, WPA, WPA_PSK, WPA2_PSK) | | ||
| | password | <code>String</code> | password to use | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | mode | <code>string</code> | wireless mode (Open, WEP, WPA, WPA_PSK, WPA2_PSK) | | ||
| | password | <code>string</code> | password to use | | ||
| | successCB | <code>function</code> | A callback function to be called when configuration was successful | | ||
@@ -107,2 +110,24 @@ | errorCB | <code>Object</code> | A callback function to be called when configuration was not successful | | ||
| <a name="cordova.plugins.hotspot+isHotspotEnabled"></a> | ||
| ### cordova.plugins.hotspot.isHotspotEnabled(enabledCB, disabledCB) | ||
| Checks if hot spot is enabled | ||
| **Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
| | Param | Description | | ||
| | --- | --- | | ||
| | enabledCB | is called if hotspot is on | | ||
| | disabledCB | called if hotspot is off | | ||
| <a name="cordova.plugins.hotspot+getAllHotspotDevices"></a> | ||
| ### cordova.plugins.hotspot.getAllHotspotDevices(successCB, errorCB) | ||
| Get all connected devices | ||
| **Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | successCB | <code>ip</code> | <code>mac</code> | A callback function to be called when connected successful and is called with an array of JSON objects: | | ||
| | errorCB | | A callback function to be called when connection was not successful | | ||
| <a name="cordova.plugins.hotspot+connectToHotspot"></a> | ||
@@ -116,7 +141,22 @@ ### cordova.plugins.hotspot.connectToHotspot(ssid, password, successCB, errorCB) | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | password | <code>String</code> | password to use | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | password | <code>string</code> | password to use | | ||
| | successCB | <code>function</code> | A callback function to be called when connected successful | | ||
| | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| <a name="cordova.plugins.hotspot+connectToWifiAuthEncrypt"></a> | ||
| ### cordova.plugins.hotspot.connectToWifiAuthEncrypt(ssid, password, authentication, encryption, successCB, errorCB) | ||
| configure current WiFi Hotspot | ||
| **Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | password | <code>string</code> | password to use | | ||
| | authentication | <code>string</code> | mode use (LEAP, SHARED, OPEN) | | ||
| | encryption | <code>Array.<string></code> | mode use (CCMP, TKIP, WEP104, WEP40) | | ||
| | successCB | <code>function</code> | A callback function to be called when connected successful | | ||
| | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| <a name="cordova.plugins.hotspot+configureHotspot"></a> | ||
@@ -130,5 +170,5 @@ ### cordova.plugins.hotspot.configureHotspot(ssid, mode, password, successCB, errorCB) | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | mode | <code>String</code> | mode use (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>String</code> | password to use | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | mode | <code>string</code> | mode use (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>string</code> | password to use | | ||
| | successCB | <code>function</code> | A callback function to be called when connected successful | | ||
@@ -145,5 +185,5 @@ | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | mode | <code>String</code> | mode use (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>String</code> | password to use | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | mode | <code>string</code> | mode use (Open, WEP, WPA, WPA_PSK) | | ||
| | password | <code>string</code> | password to use | | ||
| | successCB | <code>function</code> | A callback function to be called when connected successful | | ||
@@ -160,3 +200,3 @@ | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| | --- | --- | --- | | ||
| | ssid | <code>String</code> | SSID to connect | | ||
| | ssid | <code>string</code> | SSID to connect | | ||
| | successCB | <code>function</code> | A callback function to be called when connected successful | | ||
@@ -296,3 +336,3 @@ | errorCB | <code>Object</code> | A callback function to be called when connection was not successful | | ||
| | --- | --- | --- | | ||
| | ip | <code>String</code> | host IP | | ||
| | ip | <code>string</code> | host IP | | ||
| | successCB | <code>function</code> | A callback function to be called with all information | | ||
@@ -309,3 +349,3 @@ | errorCB | <code>Object</code> | An error callback | | ||
| | --- | --- | --- | | ||
| | ip | <code>String</code> | host IP | | ||
| | ip | <code>string</code> | host IP | | ||
| | successCB | <code>function</code> | A callback function to be called with all information | | ||
@@ -322,3 +362,3 @@ | errorCB | <code>Object</code> | An error callback | | ||
| | --- | --- | --- | | ||
| | ip | <code>String</code> | host IP | | ||
| | ip | <code>string</code> | host IP | | ||
| | successCB | <code>function</code> | A callback function to be called with all information | | ||
@@ -335,3 +375,3 @@ | errorCB | <code>Object</code> | An error callback | | ||
| | --- | --- | --- | | ||
| | ip | <code>String</code> | host IP | | ||
| | ip | <code>string</code> | host IP | | ||
| | successCB | <code>function</code> | A callback function to be called with all information | | ||
@@ -338,0 +378,0 @@ | errorCB | <code>Object</code> | An error callback | |
@@ -38,3 +38,3 @@ /* | ||
| * Check if plugin is available | ||
| * @param {Function} callback | ||
| * @param {function} callback | ||
| * A callback function with true or false as response | ||
@@ -53,3 +53,3 @@ */ | ||
| * | ||
| * @param {Function} callback | ||
| * @param {function} callback | ||
| * A callback function with true or false as response,true if wifi ON and false if wifi OFF | ||
@@ -70,12 +70,13 @@ * @param {Object} errorCB | ||
| }, | ||
| /** | ||
| * Create a WiFi Hotspot | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} mode | ||
| * @param {string} mode | ||
| * wireless mode (Open, WEP, WPA, WPA_PSK) | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when start was successful | ||
@@ -90,6 +91,7 @@ * @param {Object} errorCB | ||
| }, | ||
| /** | ||
| * Start a default WiFi Hotspot | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when start was successful | ||
@@ -104,12 +106,13 @@ * @param {Object} errorCB | ||
| }, | ||
| /** | ||
| * Configure a running WiFi Hotspot | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} mode | ||
| * @param {string} mode | ||
| * wireless mode (Open, WEP, WPA, WPA_PSK, WPA2_PSK) | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when configuration was successful | ||
@@ -127,3 +130,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when stop was successful | ||
@@ -139,10 +142,20 @@ * @param {Object} errorCB | ||
| isHotspotEnabled: function (successCB, errorCB) { | ||
| cordova.exec(successCB, function (err) { | ||
| errorCB(err); | ||
| /** | ||
| * Checks if hot spot is enabled | ||
| * @param enabledCB is called if hotspot is on | ||
| * @param disabledCB called if hotspot is off | ||
| */ | ||
| isHotspotEnabled: function (enabledCB, disabledCB) { | ||
| cordova.exec(enabledCB, function (err) { | ||
| disabledCB(err); | ||
| }, "HotSpotPlugin", "isHotspotEnabled", []); | ||
| }, | ||
| /** | ||
| * Get all connected devices | ||
| * @param successCB | ||
| * A callback function to be called when connected successful and is called with an array of JSON objects { ip: ..., mac: ... } | ||
| * @param errorCB | ||
| * A callback function to be called when connection was not successful | ||
| */ | ||
| getAllHotspotDevices: function (successCB, errorCB) { | ||
@@ -157,7 +170,7 @@ cordova.exec(successCB, function (err) { | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connected successful | ||
@@ -172,14 +185,15 @@ * @param {Object} errorCB | ||
| }, | ||
| /** | ||
| * configure current WiFi Hotspot | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {String} authentication | ||
| * @param {string} authentication | ||
| * mode use (LEAP, SHARED, OPEN) | ||
| * @param {string[]} encryption | ||
| * mode use (Open, WEP, WPA, WPA_PSK) | ||
| * @param {Function} successCB | ||
| * mode use (CCMP, TKIP, WEP104, WEP40) | ||
| * @param {function} successCB | ||
| * A callback function to be called when connected successful | ||
@@ -189,19 +203,18 @@ * @param {Object} errorCB | ||
| */ | ||
| connectToWifiAuthEncrypt: function (ssid, password, authentication, successCB, errorCB) { | ||
| connectToWifiAuthEncrypt: function (ssid, password, authentication, encryption, successCB, errorCB) { | ||
| cordova.exec(successCB, function (err) { | ||
| errorCB(err); | ||
| }, "HotSpotPlugin", "connectToWifiAuthEncrypt", [ssid, password, mode]); | ||
| }, "HotSpotPlugin", "connectToWifiAuthEncrypt", [ssid, password, authentication, encryption]); | ||
| }, | ||
| /** | ||
| * configure current WiFi Hotspot | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} mode | ||
| * @param {string} mode | ||
| * mode use (Open, WEP, WPA, WPA_PSK) | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connected successful | ||
@@ -220,9 +233,9 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {String} mode | ||
| * @param {string} mode | ||
| * mode use (Open, WEP, WPA, WPA_PSK) | ||
| * @param {String} password | ||
| * @param {string} password | ||
| * password to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connected successful | ||
@@ -241,5 +254,5 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ssid | ||
| * @param {string} ssid | ||
| * SSID to connect | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connected successful | ||
@@ -257,3 +270,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connection is active | ||
@@ -271,3 +284,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when connection is done via wifi | ||
@@ -285,3 +298,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when WiFi is enabled | ||
@@ -299,3 +312,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when WiFi is supported | ||
@@ -313,3 +326,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when WiFi Direct is supported | ||
@@ -327,3 +340,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when scan is done | ||
@@ -341,3 +354,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when scan is done | ||
@@ -359,3 +372,3 @@ * @param {Object} errorCB | ||
| * duration to use | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when scan is started | ||
@@ -373,3 +386,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called when scan is stopped | ||
@@ -387,3 +400,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -401,3 +414,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -415,5 +428,5 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ip | ||
| * @param {string} ip | ||
| * host IP | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -459,5 +472,5 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ip | ||
| * @param {string} ip | ||
| * host IP | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -475,5 +488,5 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ip | ||
| * @param {string} ip | ||
| * host IP | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -497,5 +510,5 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {String} ip | ||
| * @param {string} ip | ||
| * host IP | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -517,3 +530,3 @@ * @param {Object} errorCB | ||
| * | ||
| * @param {Function} successCB | ||
| * @param {function} successCB | ||
| * A callback function to be called with all information | ||
@@ -520,0 +533,0 @@ * @param {Object} errorCB |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.01%
28561241
- Lines of code
- increased by2.29%
535
No dependency changes