GpsPlugin class Null safety

Plugin that allows for the simulation of testing with different locations without having to actually move the device. This also allows testing on devices where a GPS chip may not exist.

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

Mixed in types

Constructors

GpsPlugin()
factory

Properties

currentLocation Future<Position>
Returns the current devices's position. If overridden, this will return the overriden value. Otherwise, it will return the value from the Geolocator.
read-only
hashCode int
The hash code for this object. [...]
read-only, inherited
locationPermission Future<LocationPermission>
Returns whether the current permission state for the device.
read-only
onLocationChanged Stream<Position>
Returns the stream that will fire with new positions whenever the device's location changes.
read-only
overriddenLocation Position?
Returns the overridden location. If the location has not been overridden then this will return null.
read / write
overriddenLocationPermission LocationPermission?
write-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

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. For example, on Android, this is called when the user presses the back button. [...]
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
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.
getPermissionForString(String value) LocationPermission
Returns the permission enum value for the given value string.
getPermissionString(LocationPermission value) String
Returns the permission string value for the given value permission.
initialize({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 the Geolocator.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
refresh() Future<void>
requestPermission() Future<LocationPermission>
reset() → void
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited