cordova-plugin-hotspot
Advanced tools
Comparing version 1.2.7 to 1.2.8-dev-10
{ | ||
"name": "cordova-plugin-hotspot", | ||
"version": "1.2.7", | ||
"version": "1.2.8-dev-10", | ||
"description": "Cordova WiFi Hotspot Plugin", | ||
@@ -22,5 +22,18 @@ "cordova": { | ||
"scripts": { | ||
"pretest": "rm -rf tmp && mkdir -p tmp && cd tmp && git clone https://github.com/simpligility/maven-android-sdk-deployer.git && cd maven-android-sdk-deployer/ && mvn install -P 6.0 && ls ~/.m2/repository/android/android/", | ||
"test": "cd tmp && git clone https://github.com/apache/cordova-app-hello-world.git && cd cordova-app-hello-world && cp -rp template_src/ . && cordova platform add android && cordova plugin add cordova-plugin-compat && cordova build && cd ../../test/android && ./gradlew build && cd ../../tmp/cordova-app-hello-world && cordova plugin add ../.. && cordova plugin add http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework.git", | ||
"posttest": "jsdoc -c jsdoc.json && jsdoc2md www/HotSpotPlugin.js | sed s/hotSpotPlugin/cordova.plugins.hotspot/g | sed s/HotSpotPlugin/cordova.plugins.hotspot/g > PLUGIN_USAGE.MD" | ||
"build": "echo ''", | ||
"prepare:sdk": "mkdir -p tmp && cd tmp && git clone https://github.com/simpligility/maven-android-sdk-deployer.git && cd maven-android-sdk-deployer/ && mvn install -P 6.0 && ls ~/.m2/repository/android/android/", | ||
"prepare:test-app": "rm -rf tmp && mkdir -p tmp && cd tmp && git clone https://github.com/apache/cordova-app-hello-world.git && cd cordova-app-hello-world && mv template_src/* . && cordova platform add android && cordova plugin add cordova-plugin-compat && cordova build", | ||
"pretest": "npm run prepare:test-app", | ||
"test": "npm run test:unit && npm run test:plugin", | ||
"test:unit": "cd test/android && ./gradlew clean build", | ||
"test:plugin": "cd tmp/cordova-app-hello-world && cordova plugin add ../.. && cordova plugin add http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework.git", | ||
"posttest": "jsdoc -c jsdoc.json && jsdoc2md www/HotSpotPlugin.js | sed s/hotSpotPlugin/cordova.plugins.hotspot/g | sed s/HotSpotPlugin/cordova.plugins.hotspot/g > PLUGIN_USAGE.MD", | ||
"jsdoc": "jsdoc -c ./jsdoc.json -t ./node_modules/ink-docstrap/template -R README.md ./src && jsdoc2md www/HotSpotPlugin.js > ./dist/PLUGIN_USAGE.MD && cat ./dist/PLUGIN_USAGE.MD | sed s/hotSpotPlugin/cordova.plugins.hotspot/g | sed s/HotSpotPlugin/cordova.plugins.hotspot/g > PLUGIN_USAGE.MD", | ||
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0", | ||
"changelog:add": "git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md'", | ||
"release:pre": "npm run build && npm run test", | ||
"release:post": "node etc/release.js && git add plugin.xml && git commit -m 'Update plugin' && npm run changelog && npm run changelog:add", | ||
"release:major": "npm version major && npm run release:pre && git push origin && git push origin --tags && npm run release:post && npm publish", | ||
"release:minor": "npm version minor && npm run release:pre && git push origin && git push origin --tags && npm run release:post && npm publish", | ||
"release:patch": "npm version patch && npm run release:pre && git push origin && git push origin --tags && npm run release:post && npm publish" | ||
}, | ||
@@ -30,5 +43,8 @@ "author": "Martin Reinhardt", | ||
"devDependencies": { | ||
"jsdoc": "3.4.0", | ||
"jsdoc-to-markdown": "1.3.3" | ||
"conventional-changelog-cli": "1.3.0", | ||
"ink-docstrap": "1.3.0", | ||
"jsdoc": "3.5.0", | ||
"jsdoc-to-markdown": "3.0.0", | ||
"xml2js": "0.4.17" | ||
} | ||
} |
@@ -104,2 +104,3 @@ ## Objects | ||
<a name="cordova.plugins.hotspot"></a> | ||
## cordova.plugins.hotspot : <code>object</code> | ||
@@ -141,27 +142,30 @@ **Kind**: global namespace | ||
<a name="cordova.plugins.hotspot+isAvailable"></a> | ||
### cordova.plugins.hotspot.isAvailable(callback) | ||
Check if plugin is available | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| callback | <code>[isAvailableCallback](#isAvailableCallback)</code> | A callback function which is invoked on success. | | ||
| callback | [<code>isAvailableCallback</code>](#isAvailableCallback) | A callback function which is invoked on success. | | ||
<a name="cordova.plugins.hotspot+getWriteSettings"></a> | ||
### cordova.plugins.hotspot.getWriteSettings(successCB, errorCB) | ||
get the current write settings of the app | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | | ||
| --- | --- | | ||
| successCB | <code>[getWriteSettingsCallback](#getWriteSettingsCallback)</code> | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | | ||
| successCB | [<code>getWriteSettingsCallback</code>](#getWriteSettingsCallback) | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | | ||
<a name="cordova.plugins.hotspot+requestWriteSettings"></a> | ||
### cordova.plugins.hotspot.requestWriteSettings(callback, error) | ||
get the current write settings of the app | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -174,17 +178,19 @@ | Param | Type | Description | | ||
<a name="cordova.plugins.hotspot+toggleWifi"></a> | ||
### cordova.plugins.hotspot.toggleWifi(callback, errorCB) | ||
Method to Toggle wifi ON/OFF | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| callback | <code>[toggleWifiCallback](#toggleWifiCallback)</code> | A callback function which is invoked on success. | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when errors occurr | | ||
| callback | [<code>toggleWifiCallback</code>](#toggleWifiCallback) | A callback function which is invoked on success. | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when errors occurr | | ||
<a name="cordova.plugins.hotspot+createHotspot"></a> | ||
### cordova.plugins.hotspot.createHotspot(ssid, mode, password, successCB, errorCB) | ||
Create a WiFi Hotspot | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -196,54 +202,59 @@ | Param | Type | Description | | ||
| password | <code>string</code> | password to use | | ||
| successCB | <code>[createHotspotCallback](#createHotspotCallback)</code> | A callback function to be called when start was successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when connection was not successful | | ||
| successCB | [<code>createHotspotCallback</code>](#createHotspotCallback) | A callback function to be called when start was successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when connection was not successful | | ||
<a name="cordova.plugins.hotspot+startHotspot"></a> | ||
### cordova.plugins.hotspot.startHotspot(successCB, errorCB) | ||
Start a default WiFi Hotspot | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[startHotspotCallback](#startHotspotCallback)</code> | A callback function to be called when start was successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when start was not successful | | ||
| successCB | [<code>startHotspotCallback</code>](#startHotspotCallback) | A callback function to be called when start was successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when start was not successful | | ||
<a name="cordova.plugins.hotspot+stopHotspot"></a> | ||
### cordova.plugins.hotspot.stopHotspot(successCB, errorCB) | ||
Stop a running default WiFi Hotspot | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[stopHotspotCallback](#stopHotspotCallback)</code> | A callback function to be called when stop was successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when stop was not successful | | ||
| successCB | [<code>stopHotspotCallback</code>](#stopHotspotCallback) | A callback function to be called when stop was successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when stop was not successful | | ||
<a name="cordova.plugins.hotspot+isHotspotEnabled"></a> | ||
### cordova.plugins.hotspot.isHotspotEnabled(successCB, errorCB) | ||
Checks if hot spot is enabled | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isHotspotEnabledCallback](#isHotspotEnabledCallback)</code> | A callback function with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A error callback function | | ||
| successCB | [<code>isHotspotEnabledCallback</code>](#isHotspotEnabledCallback) | A callback function with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A error callback function | | ||
<a name="cordova.plugins.hotspot+getAllHotspotDevices"></a> | ||
### cordova.plugins.hotspot.getAllHotspotDevices(A, errorCB) | ||
Get all connected devices | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| A | <code>[getAllHotspotDevicesCallback](#getAllHotspotDevicesCallback)</code> | callback function when hotspot connection is active and info was rad. | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| A | [<code>getAllHotspotDevicesCallback</code>](#getAllHotspotDevicesCallback) | callback function when hotspot connection is active and info was rad. | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+connectToWifi"></a> | ||
### cordova.plugins.hotspot.connectToWifi(ssid, password, successCB, errorCB) | ||
Connect to a WiFi network | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -254,10 +265,11 @@ | Param | Type | Description | | ||
| password | <code>string</code> | password to use | | ||
| successCB | <code>[connectToWifiCallback](#connectToWifiCallback)</code> | A callback function to be called when connected successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when connection was not successful | | ||
| successCB | [<code>connectToWifiCallback</code>](#connectToWifiCallback) | A callback function to be called when connected successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | 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> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -270,10 +282,11 @@ | Param | Type | Description | | ||
| encryption | <code>Array.<string></code> | mode use (CCMP, TKIP, WEP104, WEP40) | | ||
| successCB | <code>[connectToWifiAuthEncryptCallback](#connectToWifiAuthEncryptCallback)</code> | A callback function to be called when connected successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when connection was not successful | | ||
| successCB | [<code>connectToWifiAuthEncryptCallback</code>](#connectToWifiAuthEncryptCallback) | A callback function to be called when connected successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when connection was not successful | | ||
<a name="cordova.plugins.hotspot+configureHotspot"></a> | ||
### cordova.plugins.hotspot.configureHotspot(ssid, mode, password, successCB, errorCB) | ||
configure current WiFi Hotspot | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -285,10 +298,11 @@ | Param | Type | Description | | ||
| password | <code>string</code> | password to use | | ||
| successCB | <code>[configureHotspotCallback](#configureHotspotCallback)</code> | A callback function to be called when connected successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when configuration was not successful | | ||
| successCB | [<code>configureHotspotCallback</code>](#configureHotspotCallback) | A callback function to be called when connected successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when configuration was not successful | | ||
<a name="cordova.plugins.hotspot+addWifiNetwork"></a> | ||
### cordova.plugins.hotspot.addWifiNetwork(ssid, mode, password, successCB, errorCB) | ||
add a WiFi network | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -301,9 +315,10 @@ | Param | Type | Description | | ||
| successCB | <code>function</code> | A callback function to be called when adding successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when adding was not successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when adding was not successful | | ||
<a name="cordova.plugins.hotspot+removeWifiNetwork"></a> | ||
### cordova.plugins.hotspot.removeWifiNetwork(ssid, successCB, errorCB) | ||
Delete a WiFi network | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -314,75 +329,82 @@ | Param | Type | Description | | ||
| successCB | <code>function</code> | A callback function function to be called when removal was successful | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | A callback function to be called when removal was not successful | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | A callback function to be called when removal was not successful | | ||
<a name="cordova.plugins.hotspot+isConnectedToInternet"></a> | ||
### cordova.plugins.hotspot.isConnectedToInternet(successCB, errorCB) | ||
Check if connection to internet is active | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isConnectedToInternetCallback](#isConnectedToInternetCallback)</code> | A callback function to be called with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isConnectedToInternetCallback</code>](#isConnectedToInternetCallback) | A callback function to be called with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isConnectedToInternetViaWifi"></a> | ||
### cordova.plugins.hotspot.isConnectedToInternetViaWifi(successCB, errorCB) | ||
Check if connection to internet is active via WiFi | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isConnectedToInternetViaWifiCallback](#isConnectedToInternetViaWifiCallback)</code> | A callback function to be called with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isConnectedToInternetViaWifiCallback</code>](#isConnectedToInternetViaWifiCallback) | A callback function to be called with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isWifiOn"></a> | ||
### cordova.plugins.hotspot.isWifiOn(successCB, errorCB) | ||
Check if WiFi is enabled | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isWifiOnCallback](#isWifiOnCallback)</code> | A callback function with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isWifiOnCallback</code>](#isWifiOnCallback) | A callback function with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isWifiSupported"></a> | ||
### cordova.plugins.hotspot.isWifiSupported(successCB, errorCB) | ||
Check if WiFi is supported | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isWifiSupportedCallback](#isWifiSupportedCallback)</code> | A callback function with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isWifiSupportedCallback</code>](#isWifiSupportedCallback) | A callback function with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isWifiDirectSupported"></a> | ||
### cordova.plugins.hotspot.isWifiDirectSupported(successCB, errorCB) | ||
Check if WiFi Direct is supported | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isWifiDirectSupportedCallback](#isWifiDirectSupportedCallback)</code> | A callback function with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isWifiDirectSupportedCallback</code>](#isWifiDirectSupportedCallback) | A callback function with the result | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+scanWifi"></a> | ||
### cordova.plugins.hotspot.scanWifi(successCB, errorCB) | ||
Scan wifi | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[scanWifiCallback](#scanWifiCallback)</code> | A callback function to be called when scan is started | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>scanWifiCallback</code>](#scanWifiCallback) | A callback function to be called when scan is started | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+scanWifiByLevel"></a> | ||
### cordova.plugins.hotspot.scanWifiByLevel(successCB, errorCB) | ||
Scan wifi by level | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -392,9 +414,10 @@ | Param | Type | Description | | ||
| successCB | <code>scanWifiByLevelCallback</code> | A callback function to be called when scan is started | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+startWifiPeriodicallyScan"></a> | ||
### cordova.plugins.hotspot.startWifiPeriodicallyScan(interval, duration, successCB, errorCB) | ||
Start a periodically scan wifi | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -405,43 +428,47 @@ | Param | Type | Description | | ||
| duration | <code>long</code> | duration to use | | ||
| successCB | <code>[startWifiPeriodicallyScanCallback](#startWifiPeriodicallyScanCallback)</code> | A callback function to be called when scan is started | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>startWifiPeriodicallyScanCallback</code>](#startWifiPeriodicallyScanCallback) | A callback function to be called when scan is started | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+stopWifiPeriodicallyScan"></a> | ||
### cordova.plugins.hotspot.stopWifiPeriodicallyScan(successCB, errorCB) | ||
Stop a periodically scan wifi | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[stopWifiPeriodicallyScanCallback](#stopWifiPeriodicallyScanCallback)</code> | A callback function to be called when scan is stopped | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>stopWifiPeriodicallyScanCallback</code>](#stopWifiPeriodicallyScanCallback) | A callback function to be called when scan is stopped | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+getNetConfig"></a> | ||
### cordova.plugins.hotspot.getNetConfig(successCB, errorCB) | ||
Get network information, e.g Gateway Ip/Mac Device Mac/Ip etc | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[getNetConfigCallback](#getNetConfigCallback)</code> | A callback function to be called with all information | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>getNetConfigCallback</code>](#getNetConfigCallback) | A callback function to be called with all information | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+getConnectionInfo"></a> | ||
### cordova.plugins.hotspot.getConnectionInfo(successCB, errorCB) | ||
Get current connection information, e.g SSID, linkSpeed,IPAddress etc | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[getConnectionInfoCallback](#getConnectionInfoCallback)</code> | A callback function with the connection details. | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>getConnectionInfoCallback</code>](#getConnectionInfoCallback) | A callback function with the connection details. | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+pingHost"></a> | ||
### cordova.plugins.hotspot.pingHost(ip, successCB, errorCB) | ||
Ping a host | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -451,10 +478,11 @@ | Param | Type | Description | | ||
| ip | <code>string</code> | host IP | | ||
| successCB | <code>[pingHostCallback](#pingHostCallback)</code> | A callback function to be called with all information | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>pingHostCallback</code>](#pingHostCallback) | A callback function to be called with all information | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+getMacAddressOfHost"></a> | ||
### cordova.plugins.hotspot.getMacAddressOfHost(ip, successCB, errorCB) | ||
Get MAC address of host | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -465,9 +493,10 @@ | Param | Type | Description | | ||
| successCB | <code>getMacAddressOfHost</code> | A callback function to be called with all information | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isDnsLive"></a> | ||
### cordova.plugins.hotspot.isDnsLive(ip, successCB, errorCB) | ||
dnsLive | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -478,9 +507,10 @@ | Param | Type | Description | | ||
| successCB | <code>function</code> | A callback function to be called with the result | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isPortLive"></a> | ||
### cordova.plugins.hotspot.isPortLive(ip, successCB, errorCB) | ||
is port available | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
@@ -490,17 +520,19 @@ | Param | Type | Description | | ||
| ip | <code>string</code> | host IP | | ||
| successCB | <code>[isPortLiveCallback](#isPortLiveCallback)</code> | A callback function to be called with all information | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isPortLiveCallback</code>](#isPortLiveCallback) | A callback function to be called with all information | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="cordova.plugins.hotspot+isRooted"></a> | ||
### cordova.plugins.hotspot.isRooted(successCB, errorCB) | ||
Check Device is Rooted | ||
**Kind**: instance method of <code>[cordova.plugins.hotspot](#cordova.plugins.hotspot)</code> | ||
**Kind**: instance method of [<code>cordova.plugins.hotspot</code>](#cordova.plugins.hotspot) | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| successCB | <code>[isRootedCallback](#isRootedCallback)</code> | A callback function to be called with all information | | ||
| errorCB | <code>[errorCallback](#errorCallback)</code> | An error callback | | ||
| successCB | [<code>isRootedCallback</code>](#isRootedCallback) | A callback function to be called with all information | | ||
| errorCB | [<code>errorCallback</code>](#errorCallback) | An error callback | | ||
<a name="errorCallback"></a> | ||
## errorCallback : <code>function</code> | ||
@@ -516,2 +548,3 @@ Callback which provides the error details. | ||
<a name="isAvailableCallback"></a> | ||
## isAvailableCallback : <code>function</code> | ||
@@ -527,2 +560,3 @@ Callback which provides the toggle Wifi info | ||
<a name="getWriteSettingsCallback"></a> | ||
## getWriteSettingsCallback : <code>function</code> | ||
@@ -536,2 +570,3 @@ **Kind**: global typedef | ||
<a name="toggleWifiCallback"></a> | ||
## toggleWifiCallback : <code>function</code> | ||
@@ -547,2 +582,3 @@ Callback which provides the toggle Wifi info | ||
<a name="createHotspotCallback"></a> | ||
## createHotspotCallback : <code>function</code> | ||
@@ -553,2 +589,3 @@ A callback function to be called when start was successful | ||
<a name="startHotspotCallback"></a> | ||
## startHotspotCallback : <code>function</code> | ||
@@ -559,2 +596,3 @@ A callback function to be called when start was successful | ||
<a name="stopHotspotCallback"></a> | ||
## stopHotspotCallback : <code>function</code> | ||
@@ -565,2 +603,3 @@ A callback function to be called when stop was successful | ||
<a name="isHotspotEnabledCallback"></a> | ||
## isHotspotEnabledCallback : <code>function</code> | ||
@@ -576,2 +615,3 @@ A callback function to be called when stop was successful | ||
<a name="getAllHotspotDevicesCallback"></a> | ||
## getAllHotspotDevicesCallback : <code>function</code> | ||
@@ -588,2 +628,3 @@ A callback function to be called when connected successful and is | ||
<a name="connectToWifiCallback"></a> | ||
## connectToWifiCallback : <code>function</code> | ||
@@ -594,2 +635,3 @@ A callback function to be called when connected successful | ||
<a name="connectToWifiAuthEncryptCallback"></a> | ||
## connectToWifiAuthEncryptCallback : <code>function</code> | ||
@@ -600,2 +642,3 @@ A callback function to be called when connected successful | ||
<a name="configureHotspotCallback"></a> | ||
## configureHotspotCallback : <code>function</code> | ||
@@ -606,2 +649,3 @@ A callback function to be called when connected successful | ||
<a name="addWifiNetworkCallback"></a> | ||
## addWifiNetworkCallback : <code>function</code> | ||
@@ -612,2 +656,3 @@ A callback function to be called when connected successful | ||
<a name="removeWifiNetworkCallback"></a> | ||
## removeWifiNetworkCallback : <code>function</code> | ||
@@ -618,2 +663,3 @@ A callback function function to be called when removal was successful | ||
<a name="isConnectedToInternetCallback"></a> | ||
## isConnectedToInternetCallback : <code>function</code> | ||
@@ -629,2 +675,3 @@ A callback function to be called with the result | ||
<a name="isConnectedToInternetViaWifiCallback"></a> | ||
## isConnectedToInternetViaWifiCallback : <code>function</code> | ||
@@ -640,2 +687,3 @@ A callback function to be called when connection is done via wifi | ||
<a name="isWifiOnCallback"></a> | ||
## isWifiOnCallback : <code>function</code> | ||
@@ -651,2 +699,3 @@ A callback function to be called when WiFi is enabled | ||
<a name="isWifiSupportedCallback"></a> | ||
## isWifiSupportedCallback : <code>function</code> | ||
@@ -662,2 +711,3 @@ A callback function to be called when WiFi is supported | ||
<a name="isWifiDirectSupportedCallback"></a> | ||
## isWifiDirectSupportedCallback : <code>function</code> | ||
@@ -673,2 +723,3 @@ A callback function to be called when WiFi is supported | ||
<a name="scanWifiCallback"></a> | ||
## scanWifiCallback : <code>function</code> | ||
@@ -684,2 +735,3 @@ A callback function to be called when scan is started | ||
<a name="scanWifiCallback"></a> | ||
## scanWifiCallback : <code>function</code> | ||
@@ -695,2 +747,3 @@ A callback function to be called when scan is started | ||
<a name="startWifiPeriodicallyScanCallback"></a> | ||
## startWifiPeriodicallyScanCallback : <code>function</code> | ||
@@ -701,2 +754,3 @@ A callback function to be called when scan is started | ||
<a name="stopWifiPeriodicallyScanCallback"></a> | ||
## stopWifiPeriodicallyScanCallback : <code>function</code> | ||
@@ -707,2 +761,3 @@ A callback function to be called when scan is stopped | ||
<a name="getNetConfigCallback"></a> | ||
## getNetConfigCallback : <code>function</code> | ||
@@ -718,2 +773,3 @@ A callback function to be called when scan is started | ||
<a name="getConnectionInfoCallback"></a> | ||
## getConnectionInfoCallback : <code>function</code> | ||
@@ -729,2 +785,3 @@ Callback which provides the connection information. | ||
<a name="pingHostCallback"></a> | ||
## pingHostCallback : <code>function</code> | ||
@@ -740,2 +797,3 @@ Callback which provides the ping information. | ||
<a name="getMacAddressOfHostCallback"></a> | ||
## getMacAddressOfHostCallback : <code>function</code> | ||
@@ -751,2 +809,3 @@ A callback function to be called with all information | ||
<a name="isDnsLiveCallback"></a> | ||
## isDnsLiveCallback : <code>function</code> | ||
@@ -762,2 +821,3 @@ A callback function to be called with DNS details | ||
<a name="isPortLiveCallback"></a> | ||
## isPortLiveCallback : <code>function</code> | ||
@@ -773,2 +833,3 @@ A callback function to be called with DNS details | ||
<a name="isRootedCallback"></a> | ||
## isRootedCallback : <code>function</code> | ||
@@ -775,0 +836,0 @@ A callback function to be called with Rooted information |
# Cordova HotSpot Plugin | ||
**DISCONTINUED** | ||
> If anybody wants to takeover the project feel free to contact me | ||
[![Build Status](https://travis-ci.org/hypery2k/cordova-hotspot-plugin.svg?branch=master)](https://travis-ci.org/hypery2k/cordova-hotspot-plugin) [![npm version](https://badge.fury.io/js/cordova-plugin-hotspot.svg)](http://badge.fury.io/js/cordova-plugin-hotspot) [![Dependency Status](https://david-dm.org/hypery2k/cordova-hotspot-plugin.svg)](https://david-dm.org/hypery2k/cordova-hotspot-plugin) [![devDependency Status](https://david-dm.org/hypery2k/cordova-hotspot-plugin/dev-status.svg)](https://david-dm.org/hypery2k/cordova-hotspot-plugin#info=devDependencies) | ||
@@ -5,0 +8,0 @@ [![Issue Stats](http://issuestats.com/github/hypery2k/cordova-hotspot-plugin/badge/pr?style=flat)](http://issuestats.com/github/hypery2k/cordova-hotspot-plugin) [![Issue Stats](http://issuestats.com/github/hypery2k/cordova-hotspot-plugin/badge/issue?style=flat)](http://issuestats.com/github/hypery2k/cordova-hotspot-plugin) |
@@ -98,3 +98,3 @@ /* | ||
*/ | ||
requestWriteSettings: function(requestWriteSettingsCallback,errorCB) { | ||
requestWriteSettings: function(successCB,errorCB) { | ||
cordova.exec( | ||
@@ -101,0 +101,0 @@ successCB, |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
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
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
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
9956779
174
138015
44
5
2
7
3