tree: b63d3669e0b612c023271beac15567be62957c38 [path history] [tgz]
  1. android/
  2. example/
  3. ios/
  4. lib/
  5. .gitignore
  6. BUILD.gn
  7. CHANGELOG.md
  8. connectivity.iml
  9. connectivity_android.iml
  10. LICENSE
  11. pubspec.yaml
  12. README.md
connectivity/README.md

connectivity

This plugin allows Flutter apps to discover network connectivity and configure themselves accordingly. It can distinguish between cellular vs WiFi connection. This plugin works for iOS and Android.

Note that on Android, this does not guarantee connection to Internet. For instance, the app might have wifi access but it might be a VPN or a hotel WiFi with no access.

Sample usage to check current status:

import 'package:connectivity/connectivity.dart';

var connectivityResult = await (new Connectivity().checkConnectivity());
if (connectivityResult == ConnectivityResult.mobile) {
  // I am connected to a mobile network.
} else if (connectivityResult == ConnectivityResult.wifi) {
  // I am connected to a wifi network.
}

Note that you should not be using the current network status for deciding whether you can reliably make a network connection. Always guard your app code against timeouts and errors that might come from the network layer.

You can also listen for network state changes by subscribing to the stream exposed by connectivity plugin:

import 'package:connectivity/connectivity.dart';

initState() {
  subscription = new Connectivity().onConnectivityChanged.listen((ConnectivityResult result) {
    // Got a new connectivity status!
  })
}

// Be sure to cancel subscription after you are done
dispose() {
  subscription.cancel();
}

Getting Started

For help getting started with Flutter, view our online documentation.

For help on editing plugin code, view the documentation.