Geolocator

Namespace: XPlat.Device.Geolocation

Provides access to the current geographic location.

public class Geolocator : IGeolocator

Supported platforms

Platform	Version
Xamarin.Android	9.0
Xamarin.iOS	1.0
UWP	10.0.16299

Example

This example shows how to use the Geolocator class to retrieve the device's location.

using XPlat.Device.Geolocation;
...
GeolocationAccessStatus accessStatus = await Geolocator.RequestAccessAsync();
switch (accessStatus)
{
    case GeolocationAccessStatus.Allowed:
        // Approval has been granted to the application to receive location information.

        Geolocator geolocator = new Geolocator { DesiredAccuracyInMeters = 25 };

        // Subscribe to StatusChanged event to get updates of location status changes.
        geolocator.StatusChanged += OnStatusChanged;

        // Gets the current known position from the Geolocator.
        Geoposition pos = await geolocator.GetGeopositionAsync();

        UpdateLocationData(pos);
        break;

    case GeolocationAccessStatus.Denied:
        // Approval has been denied to the application to receive location information, possibly by the user.
        break;

    case GeolocationAccessStatus.Unspecified:
        // Approval has no been specified, potentially due to an error.
        break;
}

Constructors

Geolocator(Android.Content.Context) - Android

Parameters

context (Android.Content.Context)

The current Android context.

Properties

LastKnownPosition

Gets the last known position recorded by the Geolocator.

public Geoposition LastKnownPosition { get; }

ReportInterval

Gets or sets the requested minimum time interval between location updates, in milliseconds. If your application requires updates infrequently, set this value so that location services can conserve power by calculating location only when needed.

public uint ReportInterval { get; set; }

MovementThreshold

Gets or sets the distance of movement, in meters, relative to the coordinate from the last PositionChanged event, that is required for the Geolocator to raise a PositionChanged event.

public double MovementThreshold { get; set; }

LocationStatus

Gets the status that indicates the ability of the Geolocator to provide location updates.

public PositionStatus LocationStatus { get; }

DesiredAccuracy

Gets or sets the accuracy level at which the Geolocator provides location updates.

public PositionAccuracy DesiredAccuracy { get; set; }

DesiredAccuracyInMeters

Gets or sets the desired accuracy in meters for data returned from the location service.

public uint DesiredAccuracyInMeters { get; set; }

Methods

GetGeopositionAsync()

Starts an asynchronous operation to retrieve the current location of the device.

public Task<Geoposition> GetGeopositionAsync()

Returns

An asynchronous operation that, upon completion, returns a Geoposition marking the found location.

GetGeopositionAsync(TimeSpan, TimeSpan)

Starts an asynchronous operation to retrieve the current location of the device.

public Task<Geoposition> GetGeopositionAsync(TimeSpan maximumAge, TimeSpan timeout)

Parameters

maximumAge (TimeSpan)

The maximum acceptable age of cached location data.

timeout (TimeSpan)

The timeout.

Returns

An asynchronous operation that, upon completion, returns a Geoposition marking the found location.

RequestAccessAsync()

Requests permission to access location data.

public Task<GeolocationAccessStatus> RequestAccessAsync()

Returns

A GeolocationAccessStatus that indicates if permission to location data has been granted.

Events

PositionChanged

Raised when the location is updated.

public event TypedEventHandler<IGeolocator, PositionChangedEventArgs> PositionChanged;

StatusChanged

Raised when the ability of the Geolocator to provide updated location changes.

public event TypedEventHandler<IGeolocator, StatusChangedEventArgs> StatusChanged;