Connection

The connection object, exposed via navigator.connection, provides information about the device's cellular and wifi connection.

Properties

Constants

  • Connection.UNKNOWN
  • Connection.ETHERNET
  • Connection.WIFI
  • Connection.CELL_2G
  • Connection.CELL_3G
  • Connection.CELL_4G
  • Connection.CELL
  • Connection.NONE

Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-Line Interface, to add or remove this feature for a project:

    $ cordova plugin add org.apache.cordova.network-information
    $ cordova plugin ls
    [ 'org.apache.cordova.network-information' ]
    $ cordova plugin rm org.apache.cordova.network-information

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

  • Amazon Fire OS

    (in app/res/xml/config.xml)
    <feature name="NetworkStatus">
        <param name="android-package" value="org.apache.cordova.networkinformation.NetworkManager" />
    </feature>
    
    (in app/AndroidManifest.xml)
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    
  • Android

    (in app/res/xml/config.xml)
    <feature name="NetworkStatus">
        <param name="android-package" value="org.apache.cordova.networkinformation.NetworkManager" />
    </feature>
    
    (in app/AndroidManifest.xml)
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    
  • BlackBerry 10

    (in www/config.xml)
    <feature name="NetworkStatus" value="NetworkStatus"/>
    
  • iOS (in the named application directory's config.xml)

    <feature name="NetworkStatus">
        <param name="ios-package" value="CDVConnection" />
    </feature>
    
  • Windows Phone (in Properties/WPAppManifest.xml)

    <Capabilities>
        <Capability Name="ID_CAP_NETWORKING" />
    </Capabilities>
    

Reference: Application Manifest for Windows Phone

  • Tizen (in config.xml)

    <feature name="http://tizen.org/api/systeminfo" required="true"/>
    

Reference: Application Manifest for Tizen Web Application

Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.