location2
library
Enums
-
LocationAccuracy
-
Precision of the Location. A lower precision will provide a greater battery
life.
-
LocationPermission
-
Status of a granted permission or requested to use location services.
-
PermissionStatus
-
Status of a permission request to use location services.
Functions
-
getLocation({LocationSettings? settings})
→ Future<LocationData>
-
Returns the current location.
throws an Exception on Error
-
getLocationPermissionStatus()
→ Future<LocationPermissionData>
-
Get current LocationPermissionDatalocation permission status.
-
getPermissionStatus()
→ Future<PermissionStatus>
-
Get permission status.
-
isGPSEnabled()
→ Future<bool>
-
Returns true if the GPS provider is enabled
-
isNetworkEnabled()
→ Future<bool>
-
Returns true if the Network provider is enabled
-
onLocationChanged({bool inBackground = false})
→ Stream<LocationData>
-
Listen to the current location.
-
onLocationPermissionChanged()
→ Stream<LocationPermissionData>
-
Listen to the current location permissions.
-
openAppSettings()
→ Future<bool>
-
Will open the App settings page.
iOS opens only common settings page - limited by os
Web no settings available
Android - opens setting pages
-
openLocationSettings()
→ Future<bool>
-
Will open the App settings page.
iOS opens only common settings page - limited by os
Web no settings available
Android - opens setting pages
-
requestLocationPermission(LocationPermission permission)
→ Future<LocationPermission>
-
Request location permission.
-
requestPermission()
→ Future<PermissionStatus>
-
Request location permission.
-
setLocationInstance(LocationPlatform platform)
→ void
-
Allows you to mock the LocationPlatform instance for testing.
-
setLocationSettings({bool askForPermission = true, String rationaleMessageForPermissionRequest = 'The app needs to access your location', String rationaleMessageForGPSRequest = 'The app needs to access your location', bool useGooglePlayServices = true, bool askForGooglePlayServices = false, bool askForGPS = true, bool fallbackToGPS = true, bool ignoreLastKnownPosition = true, double? expirationDuration, double? expirationTime, double fastestInterval = 500, double interval = 1000, double? maxWaitTime, int? numUpdates, LocationAccuracy accuracy = LocationAccuracy.high, double smallestDisplacement = 0, bool waitForAccurateLocation = true, double? acceptableAccuracy})
→ Future<void>
-
Update global location settings.
The settings are a pass through to the LocationSettings class.
-
updateBackgroundNotification({String? channelName, String? title, String? iconName, String? subtitle, String? description, Color? color, bool? onTapBringToFront})
→ Future<bool>
-
Change options of sticky background notification on Android.
