Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/cordova-plugin-network-information
Apache Cordova Network Information Plugin
https://github.com/apache/cordova-plugin-network-information
android cordova hacktoberfest ios java javascript library mobile nodejs objective-c
Last synced: 3 days ago
JSON representation
Apache Cordova Network Information Plugin
- Host: GitHub
- URL: https://github.com/apache/cordova-plugin-network-information
- Owner: apache
- License: apache-2.0
- Created: 2013-06-22T07:00:18.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T01:34:21.000Z (3 months ago)
- Last Synced: 2024-10-29T17:29:49.601Z (3 months ago)
- Topics: android, cordova, hacktoberfest, ios, java, javascript, library, mobile, nodejs, objective-c
- Language: Objective-C
- Homepage: https://cordova.apache.org/
- Size: 427 KB
- Stars: 465
- Watchers: 48
- Forks: 321
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
title: Network Information
description: Get information about wireless connectivity.
---
# cordova-plugin-network-information
[](https://github.com/apache/cordova-plugin-network-information/actions/workflows/android.yml) [](https://github.com/apache/cordova-plugin-network-information/actions/workflows/chrome.yml) [](https://github.com/apache/cordova-plugin-network-information/actions/workflows/ios.yml) [](https://github.com/apache/cordova-plugin-network-information/actions/workflows/lint.yml)
This plugin provides an implementation of an old version of the
[Network Information API](http://www.w3.org/TR/2011/WD-netinfo-api-20110607/).
It provides information about the device's cellular and
wifi connection, and whether the device has an internet connection.
> To get a few ideas how to use the plugin, check out the [sample](#sample) at the bottom of this page or go straight to the [reference](#reference) content.
## Installation
cordova plugin add cordova-plugin-network-information
## Supported Platforms
- Android
- Browser
- iOS
- Windows
# Connection
> The `connection` object, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
## Properties
- connection.type
## Constants
- Connection.UNKNOWN
- Connection.ETHERNET
- Connection.WIFI
- Connection.CELL_2G
- Connection.CELL_3G
- Connection.CELL_4G
- Connection.CELL
- Connection.NONE
## connection.type
This property offers a fast way to determine the device's network
connection state, and type of connection.
### Quick Example
```js
function checkConnection() {
var networkState = navigator.connection.type;
var states = {};
states[Connection.UNKNOWN] = 'Unknown connection';
states[Connection.ETHERNET] = 'Ethernet connection';
states[Connection.WIFI] = 'WiFi connection';
states[Connection.CELL_2G] = 'Cell 2G connection';
states[Connection.CELL_3G] = 'Cell 3G connection';
states[Connection.CELL_4G] = 'Cell 4G connection';
states[Connection.CELL] = 'Cell generic connection';
states[Connection.NONE] = 'No network connection';
alert('Connection type: ' + states[networkState]);
}
checkConnection();
```
### iOS Quirks
-
The code examples in this section show examples of changing app behavior using the online and offline events and your network connection status.
To start with, create a new FileEntry object (data.txt) to use for sample data. Call this function from the `deviceready` handler.
>*Note* This code example requires the File plugin.
```js
var dataFileEntry;
function createSomeData() {
window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
console.log('file system open: ' + fs.name);
// Creates a new file or returns an existing file.
fs.root.getFile("data.txt", { create: true, exclusive: false }, function (fileEntry) {
dataFileEntry = fileEntry;
}, onErrorCreateFile);
}, onErrorLoadFs);
}
```
Next, add listeners for the online and offline events in the `deviceready` handler.
```js
document.addEventListener("offline", onOffline, false);
document.addEventListener("online", onOnline, false);
```
The app's `onOnline` function handles the online event. In the event handler, check the current network state. In this app, treat any connection type as good except Connection.NONE. If you have a connection, you try to upload a file.
```js
function onOnline() {
// Handle the online event
var networkState = navigator.connection.type;
if (networkState !== Connection.NONE) {
if (dataFileEntry) {
tryToUploadFile();
}
}
display('Connection type: ' + networkState);
}
```
When the online event fires in the preceding code, call the app's `tryToUploadFile` function.
If the upload fails, then call the app's `offlineWrite` function to save the current data somewhere.
>*Note* For simplicity, file reading & writing was omitted. Refer to the [cordova-plugin-file](https://github.com/apache/cordova-plugin-file#cordova-plugin-file) documentation for more information on file handling.
```js
function tryToUploadFile() {
// !! Assumes variable fileURL contains a valid URL to a text file on the device,
var fileURL = getDataFileEntry().toURL();
getFileBlobSomehow(fileURL, function(fileBlob) {
var success = function (r) {
console.log("Response = " + r.response);
display("Uploaded. Response: " + r.response);
};
var fail = function (error) {
console.log("An error has occurred: Code = " + error.code || error.status);
offlineWrite("Failed to upload: some offline data");
}
var xhr = new XMLHttpRequest();
xhr.onerror = fail;
xhr.ontimeout = fail;
xhr.onload = function() {
// If the response code was successful...
if (xhr.status >= 200 && xhr.status < 400) {
success(xhr);
}
else {
fail(xhr)
}
}
// Make sure you add the domain of your server URL to the
// Content-Security-Policy element in index.html.
xhr.open("POST", encodeURI(SERVER));
xhr.setRequestHeader("Content-Type", "text/plain");
// The server request handler could read this header to
// set the filename.
xhr.setRequestHeader("X-Filename", fileURL.substr(fileURL.lastIndexOf("/") + 1));
xhr.send(fileBlob);
});
};
```
Here is the code for the `offlineWrite` function.
>*Note* This code examples requires the File plugin.
```js
function offlineWrite(offlineData) {
// Create a FileWriter object for our FileEntry.
dataFileEntry.createWriter(function (fileWriter) {
fileWriter.onwriteend = function () {
console.log("Successful file write...");
display(offlineData);
};
fileWriter.onerror = function (e) {
console.log("Failed file write: " + e.toString());
};
fileWriter.write(offlineData);
});
}
```
If the offline event occurs, just do something like notify the user (for this example, just log it).
```js
function onOffline() {
// Handle the offline event
console.log("lost connection");
}
```