Connectivity | NativeScript

Connectivity provides easy-to-use APIs consolidating the appropriate platform native APIs to interact with the network's connection type and availability.

Using Connectivity

To use Connectivity, import it from @nativescript/core.

import { Connectivity } from '@nativescript/core'

Getting the current connection type

To check what type of network is currently connected use the getConnectionType() method.

const connectionType: number = Connectivity.getConnectionType()

if (connectionType) {
  // `Connectivity.connectionType.none`` is `0` so truthiness can be used to determine if the device is connected to any type of network
  fetch('https://httpbin.org/get')
    .then((response) => reponse.text())
    .then((result) => console.log(`Fetched ${result} with ${connectionType}`))
} else {
  console.log('Not connected to a network.')
}

Conditional behavior can easily be added for certain types of connections using the Connectivity.connectionType enum.

if (
  connectionType === Connectivity.connectionType.wifi ||
  connectionType === Connectivity.connectionType.ethernet
) {
  // Download large file
} else {
  // Download mobile friendly file
}

Monitor changes to the connection type

Using the startMonitoring() method changes to the connection type can be observed.

Connectivity.startMonitoring((change: number) => {
  switch (change) {
    case Connectivity.connectionType.wifi:
    case Connectivity.connectionType.ethernet:
      console.log('Connected to home network')
      break
    case Connectivity.connectionType.mobile:
    case Connectivity.connectionType.bluetooth:
      console.log('Connected to mobile network')
      break
    case Connectivity.connectionType.vpn:
      console.log('Connected to vpn network')
      break
    default:
      console.log('Not connected to any network')
      break
  }
})

If you wish to halt the monitoring of connectivity changes, use the stopMonitoring() function.

Connectivity.stopMonitoring()

API

getConnectionType()

Connectivity.getConnectionType(): number

This method retrieves the current connection type. It returns a number value representing one of the connectionType enumeration values.

Note

For Android, the android.permission.ACCESS_NETWORK_STATE permission must be added to the AndroidManifest.xml file to use this method.

startMonitoring()

Connectivity.startMonitoring(connectionTypeChangedCallback: (newConnectionType: number) => void): void

This method initiates the monitoring of the network connection type. The connectionTypeChangedCallback is a function that will be invoked when the network connection type changes.

stopMonitoring()

Connectivity.stopMonitoring()

This method halts the monitoring of the network connection type.

connectionType

Connectivity.connectionType: number

This enumeration defines the different possible connection types.

More connection types

none = 0
wifi = 1
mobile = 2,
ethernet = 3,
bluetooth = 4,
vpn = 5

API Reference(s)

@nativescript/core/connectivity module
connectionType enum

Native Component

Android: CONNECTIVITY_SERVICE (android.content.Context)
iOS: SCNetworkReachability

Using Connectivity ​

Getting the current connection type ​

Monitor changes to the connection type ​

API ​

getConnectionType() ​

startMonitoring() ​

stopMonitoring() ​

connectionType ​

API Reference(s) ​

Native Component ​

Contributors