ConnectivityPlugin

Connectivity Plugin for Xamarin and Windows

Project maintained by jamesmontemagno Hosted on GitHub Pages — Theme by mattgraham

Getting Started

Setup

Using Connectivity APIs

It is drop dead simple to gain access to the Connectivity APIs in any project. All you need to do is get a reference to the current instance of IConnectivity via CrossConnectivity.Current:

public bool DoIHaveInternet()
{
    return CrossConnectivity.Current.IsConnected;
}

There may be instances where you install a plugin into a platform that it isn’t supported yet. This means you will have access to the interface, but no implementation exists. You can make a simple check before calling any API to see if it is supported on the platform where the code is running. This if nifty when unit testing:

public bool DoIHaveInternet()
{
    if(!CrossConnectivity.IsSupported)
        return true;

    return CrossConnectivity.Current.IsConnected;
}

Disposing of Connectivity Plugin

This plugin also implements IDisposable on all implementations. This ensure that all events are unregistered from the platform. Only dispose when you need to and are no longer listening to events. The next time you gain access to the CrossConnectivity.Current a new instance will be created.

public bool DoIHaveInternet()
{
    if(!CrossConnectivity.IsSupported)
        return true;
        
    //Do this only if you need to and aren't listening to any other events as they will not fire.
    var connectivity = CrossConnectivity.Current;
    
	try
	{
    	return connectivity.IsConnected;
	}
	finally
	{
		CrossConnectivity.Dispose();
	}
    
}

Permissions & Additional Setup Considerations

Android:

The ACCESS_NETWORK_STATE and ACCESS_WIFI_STATE permissions are required and are automatically added to your Android Manifest when you compile. No need to add them manually!

By adding these permissions Google Play will automatically filter out devices without specific hardware. You can get around this by adding the following to your AssemblyInfo.cs file in your Android project:

[assembly: UsesFeature("android.hardware.wifi", Required = false)]

<= Back to Table of Contents