FusedLocationProviderClient

Events:

• LocationAvailabilityChanged (Available As Boolean)
• LocationAvailabilityRequestCompleted (Available As Boolean)
• LocationChanged (mLocation As LocationF)
• LocationEnabledInSettingsChanged (Enabled As Boolean)
• LocationRequestCompleted (Result As LocationResult)

Functions:

• FlushLocations
  Flushes any locations currently being batched.
• GetCurrentLocation (Priority As Int) As Int
  Returns a single location fix representing the best estimate of the current location of the device. This may return a cached location if a recent enough location fix exists, or may compute a fresh location. If unable to retrieve a current location fix, null will be returned.
  Priority - Priority used to obtain location.
  This method is asynchronous. When the process is complete, an event "LocationRequestCompleted" will be triggered.
• GetCurrentLocation2 (DurationMillis As Long, Granularity As Int, Priority As Int, MaxUpdateAgeMillis As Long) As Int
  Returns a single location fix representing the best estimate of the current location of the device. This may return a historical location if a recent enough location fix exists, or may compute a fresh location. If unable to retrieve a current location fix, null will be returned.
  DurationMillis - Sets the duration in milliseconds of the location request used to derive the current location if no historical location satisfies the current location request. If this duration expires with no location, the current location request will return a null location. The current location request may fail and return a null location after a shorter duration, but never a longer duration. The default value is LocationRequest_Constants.MAX_VALUE.
  Granularity - Sets the Granularity of locations returned for this request. This controls whether fine or coarse locations may be returned.
  Priority - Sets the Priority of the location request used to derive the current location if no historical location satisfies the current location request.
  MaxUpdateAgeMillis - Sets the maximum age of any location returned for this request. A value of 0 indicates that only freshly derived locations will be returned, and no historical locations will ever be returned. A value LocationRequest_Constants.MAX_VALUE represents an effectively unbounded maximum age.
  This method is asynchronous. When the process is complete, an event "LocationRequestCompleted" will be triggered.
• GetLastLocation As Int
  Returns the most recent historical location currently available. Will return null if no historical location is available. The historical location may be of an arbitrary age, so clients should check how old the location is to see if it suits their purposes.
  This method is asynchronous. When the process is complete, an event "LocationRequestCompleted" will be triggered.
• GetLastLocation2 (Granularity As Int, MaxUpdateAgeMillis As Long) As Int
  Returns the most recent historical location currently available according to the given request. Will return null if no matching historical location is available.
  Granularity - The Granularity of locations returned for this request. This controls whether fine or coarse locations may be returned.
  MaxUpdateAgeMillis - The maximum age of any location returned for this request. A value of LocationRequest_Constants.MAX_VALUE represents an effectively unbounded maximum age.
  This method is asynchronous. When the process is complete, an event "LocationRequestCompleted" will be triggered.
• GetLocationAvailability
  Returns true if the device location is generally available.
  This method is asynchronous. When the process is complete, an event "LocationAvailabilityRequestCompleted" will be triggered.
• Initialize (EventName As String) As FusedLocationProviderClient
  
• IsInitialized As Boolean
  
• RemoveLocationUpdates
  Removes all location updates and stops listener for the future locations updates.
• RequestLocationUpdates (Request As LocationRequest)
  Requests location updates with the given request.
  Use RemoveLocationUpdates to stop location updates once no longer needed.
• SetMockLocation (mLocation As LocationF) As FusedLocationProviderClient
  Sets the mock location of the Fused Location Provider.
• SetMockMode (MockMode As Boolean) As FusedLocationProviderClient
  Sets whether or not the Fused Location Provider is in mock mode.

Properties:

• IsLocationEnabledInSettings As Boolean [read only]
  Check if Location is enabled in device's settings.
• LocationSettingsIntent As Intent [read only]
  Returns the intent that is used to show the global locations settings.

Granularity

Fields:

• GRANULARITY_COARSE As Int
  The desired location granularity is always coarse, regardless of the client permission level. The client will be delivered coarse locations while it has the Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION permission, and no location if it lacks either.
  Constant Value: 1
• GRANULARITY_FINE As Int
  The desired location granularity is always fine, regardless of the client permission level. The client will be delivered fine locations while it has the Manifest.permission.ACCESS_FINE_LOCATION, and no location if it lacks that permission.
  Constant Value: 2
• GRANULARITY_PERMISSION_LEVEL As Int
  The desired location granularity should correspond to the client permission level. The client will be delivered fine locations while it has the Manifest.permission.ACCESS_FINE_LOCATION permission, coarse locations while it has only the Manifest.permission.ACCESS_COARSE_LOCATION permission, and no location if it lacks either.
  Constant Value: 0

LocationF

Functions:

• BearingTo (Dest As LocationF) As Float
  Returns the approximate initial bearing in degrees east of true north when traveling along the shortest path between this location and the given location. The shortest path is defined using the WGS84 ellipsoid. Locations that are (nearly) antipodal may produce meaningless results.
• DistanceTo (Dest As LocationF) As Float
  Returns the approximate distance in meters between this location and the given location. Distance is defined using the WGS84 ellipsoid.
• HasAccuracy As Boolean
  Returns true if this location has a horizontal accuracy, false otherwise.
• HasAltitude As Boolean
  Returns true if this location has an altitude, false otherwise.
• HasBearing As Boolean
  True if this location has a bearing, false otherwise.
• HasBearingAccuracy As Boolean
  Returns true if this location has a bearing accuracy, false otherwise.
• HasSpeed As Boolean
  True if this location has a speed, false otherwise.
• HasSpeedAccuracy As Boolean
  Returns true if this location has a speed accuracy, false otherwise.
• HasVerticalAccuracy As Boolean
  Returns true if this location has a vertical accuracy, false otherwise.
• Initialize As LocationF
  
• Initialize2 (mLocationF As LocationF) As LocationF
  
• IsInitialized As Boolean
  
• Reset
  Sets the provider to null, removes all optional fields, and sets the values of all other fields to zero.
• ToString As String
  

Properties:

• Accuracy As Float
  Gets or sets the horizontal accuracy in meters of this location.
• Altitude As Double
  Gets or sets the altitude of this location in meters above the WGS84 reference ellipsoid.
• Bearing As Float
  Gets or sets the bearing at the time of this location, in degrees. The given bearing will be converted into the range (0, 360).
• BearingAccuracyDegrees As Float
  Gets or sets the bearing accuracy in degrees of this location. Bearing accuracy in degrees Value is 0.0 or greater.
• Latitude As Double
  Gets or set the latitude of this location.
• Longitude As Double
  Gets or sets the longitude of this location.
• Provider As String
  Gets or sets the name of the provider associated with this location
• Speed As Float
  Gets or sets the speed at the time of this location, in meters per second.
• SpeedAccuracyMetersPerSecond As Float
  Set the speed accuracy of this location in meters per second.
• Time As Long
  Gets or sets the Unix epoch time of this location fix, in milliseconds since the start of the Unix epoch (00:00:00 January 1 1970 UTC).
• VerticalAccuracyMeters As Float
  Gets or sets the altitude accuracy of this location in meters.

LocationF

Fields:

• FORMAT_DEGREES As Int
  Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD.DDDDD" where D indicates degrees.
  Constant Value: 0
• FORMAT_MINUTES As Int
  Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD:MM.MMMMM" where D indicates degrees and M indicates minutes of arc (1 minute = 1/60th of a degree).
  Constant Value: 1
• FORMAT_SECONDS As Int
  Constant used to specify formatting of a latitude or longitude in the form "DDD:MM:SS.SSSSS" where D indicates degrees, M indicates minutes of arc, and S indicates seconds of arc (1 minute = 1/60th of a degree, 1 second = 1/3600th of a degree).
  Constant Value: 2

Functions:

• ConvertToDouble (Coordinate As String) As Double
  Converts a String in one of the formats described by FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS into a double.
• ConvertToString (Coordinate As Double, OutputType As Int) As String
  Converts a latitude/longitude coordinate to a String representation. The outputType must be one of FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS. The coordinate must be a number between -180.0 and 180.0, inclusive. This conversion is performed in a method that is dependent on the default locale.
• DistanceBetween (startLatitude As Double, startLongitude As Double, endLatitude As Double, endLongitude As Double) As Float()
  Computes the approximate distance in meters between two locations, and optionally the initial and final bearings of the shortest path between them. Distance and bearing are defined using the WGS84 ellipsoid and stored in result().
  The computed distance is stored in results(0). If results has length 2 or greater, the initial bearing is stored in results(1). If results has length 3 or greater, the final bearing is stored in results(2).

LocationRequest

Functions:

• Equals (mObject As Object) As Boolean
  
• GetDurationMillis As Long
  The duration of this request. A location request will not receive any locations after it has expired, and will be removed shortly thereafter. A value of LocationRequest_Constants.MAX_VALUE_FLOAT implies an infinite duration.
• GetGranularity As Int
  The Granularity of locations returned for this request. This controls whether fine or coarse locations may be returned.
• GetIntervalMillis As Long
  The desired interval of location updates. Location updates may arrive faster than this interval (but no faster than specified by getMinUpdateIntervalMillis()) or slower than this interval (if the request is being throttled for example).
• GetMaxUpdateAgeMillis As Long
  The maximum age of an initial historical location delivered for this request. A value of 0 indicates that no initial historical location will be delivered, only freshly derived locations. A value LocationRequest_Constants.MAX_VALUE_FLOAT represents an effectively unbounded maximum age.
• GetMaxUpdateDelayMillis As Long
  The longest a location update may be delayed. This parameter controls location batching behavior. If this is set to a value at least 2x larger than the interval specified by getIntervalMillis(), then a device may (but is not required to) save power by delivering locations in batches. If clients do not require immediate delivery, consider setting this value as high as is reasonable to allow for additional power savings.
  For example, if a request is made with a 2s interval and a 10s maximum update delay, this implies that the device may choose to deliver batches of 5 locations every 10s (where each location should represent a point in time ~2s after the previous).
  Support for batching may vary by device type, so simply allowing batching via this parameter does not imply a client will receive batched results on all devices.
  FusedLocationProviderClient.flushLocations() may be used to flush locations that have been batched, but not delivered yet.
• GetMaxUpdates As Int
  The maximum number of updates delivered to this request. A location request will not receive any locations after the maximum number of updates has been reached, and will be removed shortly thereafter. A value of LocationRequest_Constants.MAX_VALUE_INT implies an unlimited number of updates.
• GetMinUpdateDistanceMeters As Float
  The minimum distance required between consecutive location updates. If a derived location update is not at least the specified distance away from the previous location update delivered to the client, it will not be delivered. This may also allow additional power savings under some circumstances.
• GetMinUpdateIntervalMillis As Long
  The fastest allowed interval of location updates. Location updates may arrive faster than the desired interval (getIntervalMillis()), but will never arrive faster than specified here. FLP APIs make some allowance for jitter with the minimum update interval, so clients need not worry about location updates that arrive a couple milliseconds too early being rejected.
• GetPriority As Int
  The Priority of the location request.
• GetWaitForAccurateLocation As Boolean
  If this request is Priority.PRIORITY_HIGH_ACCURACY, this will delay delivery of initial low accuracy locations for a small amount of time in case a high accuracy location can be delivered instead.
• Initialize (IntervalMillis As Long) As LocationRequest
  Constructs a LocationRequest with the given interval, and default values for all other fields.
• Initialize2 (Priority As Int, IntervalMillis As Long) As LocationRequest
  Constructs a LocationRequest with the given priority and interval, and default values for all other fields.
• Initialize3 (Request As LocationRequest) As LocationRequest
  Constructs a LocationRequest with values copied from the given LocationRequest.
• IsBatched As Boolean
  True if this request allows batching (i.e. getMaxUpdateDelayMillis() is at least 2x getIntervalMillis()).
• IsInitialized As Boolean
  
• IsPassive As Boolean
  True if the priority is Priority.PRIORITY_PASSIVE.
• SetDurationMillis (DurationMillis As Long) As LocationRequest
  Sets the duration of this request. A location request will not receive any locations after it has expired, and will be removed shortly thereafter. A value of LocationRequest_Constants.MAX_VALUE implies an infinite duration.
  The default value is LocationRequest_Constants.MAX_VALUE (unlimited).
• SetGranularity (Granularity As Int) As LocationRequest
  Sets the Granularity of locations returned for this request. This controls whether fine or coarse locations may be returned.
  The default value is Granularity.GRANULARITY_PERMISSION_LEVEL.
• SetIntervalMillis (IntervalMillis As Long) As LocationRequest
  Sets the desired interval of location updates. Location updates may arrive faster than this interval (but no faster than specified by SetMinUpdateIntervalMillis(Long)) or slower than this interval (if the request is being throttled for example).
• SetMaxUpdateAgeMillis (MaxUpdateAgeMillis As Long) As LocationRequest
  Sets the maximum age of an initial historical location delivered for this request. A value of 0 indicates that no initial historical location will be delivered, only freshly derived locations. A value LocationRequest_Constants.MAX_VALUE represents an effectively unbounded maximum age.
  This may be set to the special value LocationRequest_Constants.IMPLICIT_MAX_UPDATE_AGE in which case the maximum update age will always be the same as the interval.
  The default value is LocationRequest_Constants.IMPLICIT_MAX_UPDATE_AGE.
• SetMaxUpdateDelayMillis (MaxUpdateDelayMillis As Long) As LocationRequest
  Sets the longest a location update may be delayed. This parameter controls location batching behavior. If this is set to a value at least 2x larger than the interval specified by setIntervalMillis(long), then a device may (but is not required to) save power by delivering locations in batches. If clients do not require immediate delivery, consider setting this value as high as is reasonable to allow for additional power savings. When the LocationRequest is built, the maximum update delay will be set to the max of the provided maximum update delay and the interval. This normalizes requests without batching to have the maximum update delay equal to the interval.
  For example, if a request is made with a 2s interval and a 10s maximum update delay, this implies that the device may choose to deliver batches of 5 locations every 10s (where each location in a batch represents a point in time ~2s after the previous).
  Support for batching may vary by device hardware, so simply allowing batching via this parameter does not imply a client will receive batched results on all devices.
  FusedLocationProviderClient.FlushLocations() may be used to flush locations that have been batched, but not delivered yet.
  The default value is 0.
• SetMaxUpdates (MaxUpdates As Int) As LocationRequest
  Sets the maximum number of updates delivered to this request. A location request will not receive any locations after the maximum number of updates has been reached, and will be removed shortly thereafter. A value of Integer.MAX_VALUE implies an unlimited number of updates.
  The default value is Integer.MAX_VALUE.
• SetMinUpdateDistanceMeters (MinUpdateDistanceMeters As Float) As LocationRequest
  Sets the minimum distance required between consecutive location updates. If a derived location update is not at least the specified distance away from the previous location update delivered to the client, it will not be delivered. This may also allow additional power savings under some circumstances.
  The default value is 0.
• SetMinUpdateIntervalMillis (MinUpdateIntervalMillis As Long) As LocationRequest
  Sets the fastest allowed interval of location updates. Location updates may arrive faster than the desired interval (setIntervalMillis(long)), but will never arrive faster than specified here.
  This may be set to the special value LocationRequest_Constants.IMPLICIT_MIN_UPDATE_INTERVAL in which case the minimum update interval will be the same as the interval. FusedLocationProviderClient APIs make some allowance for jitter with the minimum update interval, so clients need not worry about location updates that arrive a couple milliseconds too early being rejected.
  The default value is LocationRequest_Constants.IMPLICIT_MIN_UPDATE_INTERVAL.
• SetPriority (Priority As Int) As LocationRequest
  Sets the Priority of the location request.
  The default value is Priority.PRIORITY_BALANCED_POWER_ACCURACY.
• SetWaitForAccurateLocation (WaitForAccurateLocation As Boolean) As LocationRequest
  If set to true and this request is Priority.PRIORITY_HIGH_ACCURACY, this will delay delivery of initial low accuracy locations for a small amount of time in case a high accuracy location can be delivered instead.
  The default value is true.
• ToString As String
  

LocationRequest

Fields:

• IMPLICIT_MAX_UPDATE_AGE As Long
  Represents a maximum update age that is the same as the interval.
  Constant Value: -1
• IMPLICIT_MIN_UPDATE_INTERVAL As Long
  Represents a minimum update interval that is the same as the interval.
  Constant Value: -1
• MAX_VALUE_FLOAT As Long
  A constant holding the maximum value a long can have.
• MAX_VALUE_INT As Int
  A constant holding the maximum value an int can have.

LocationResult

Properties:

• ErrorMessage As String [read only]
  
• Location As LocationF [read only]
  
• ResponseID As Int [read only]
  
• Status As Int [read only]
  
• StatusString As String [read only]
  

LocationResult

Fields:

• STATUS_CANCELED As Int
  
• STATUS_FAILED As Int
  
• STATUS_SUCCESSFUL As Int
  

Priority

Fields:

• PRIORITY_BALANCED_POWER_ACCURACY As Int
  Requests a tradeoff that is balanced between location accuracy and power usage.
  Constant Value: 102
• PRIORITY_HIGH_ACCURACY As Int
  Requests a tradeoff that favors highly accurate locations at the possible expense of additional power usage.
  Constant Value: 100
• PRIORITY_LOW_POWER As Int
  Requests a tradeoff that favors low power usage at the possible expense of location accuracy.
  Constant Value: 104
• PRIORITY_PASSIVE As Int
  Ensures that no extra power will be used to derive locations. This enforces that the request will act as a passive listener that will only receive "free" locations calculated on behalf of other clients, and no locations will be calculated on behalf of only this request.
  Constant Value: 105