ConnectivityPlugin class

Plugin that allows for the simulation of being connected or disconnected from internet for automated connectivity testing without having to actually enable / disable the entire phone's connection.

As a note, this won't actually change the real device's connectivity. So users of this plugin must utilize it for all connectivity checks or unexpected results may be encountered.

This is a singleton. All "new" instances are the same object reference.

Mixed in types

Constructors

ConnectivityPlugin()
factory

Properties

connected → bool
Returns whether or not the device is currently connected.
no setter
hashCode → int
The hash code for this object.
no setterinherited
onConnectedChanged → Stream<bool>
Returns the stream that will fire with a true when connectivity is restored and false when connectivity is lost.
no setter
overriddenConnected ↔ bool?
Returns the overridden connection type. If the connection type has not been overridden then this will return null.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called by the framework when the application launch state changes.
override
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
dispose() → void
Disposes the plugin, stops all streams, and stops all listeners. Once disposed, this plugin cannot be used again until the application fully restarts.
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
initialize({Stream<bool>? connectedStream, TestController? testController}) → Future<void>
Initializes the plugin with an optional TestController. If the TestController is not set then this acts as nothing more than a wrapper to
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refresh() → Future<bool>
Refreshes the connectivity. It's typically better to listen to the stream, but for one off checks, app start, or app restart, it is good to manually refresh as well.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited