BlazorDeviceInterop/Darnton.Blazor.DeviceInterop/Geolocation/IGeolocationService.cs

using System;
using System.Threading.Tasks;

namespace Darnton.Blazor.DeviceInterop.Geolocation
{
    /// <summary>
    /// A wrapper around the device's Geolocation API services.
    /// <see href="https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API"/>.
    /// </summary>
    public interface IGeolocationService
    {
        /// <summary>
        /// A wrapper around the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/getCurrentPosition"/> function,
        /// used to get the current position of the device.
        /// </summary>
        /// <param name="options"><see cref="PositionOptions"/> used to modify the request.</param>
        /// <returns>The result of the geolocation request.</returns>
        Task<GeolocationResult> GetCurrentPosition(PositionOptions options = null);
        /// <summary>
        /// A wrapper around the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/watchPosition"/> function,
        /// used to listen for position changes. If the service is listening, a <see cref="WatchPositionReceived"/> event is fired
        /// each time the device's position changes.
        /// </summary>
        /// <param name="options"><see cref="PositionOptions"/> used to modify the request.</param>
        /// <returns>A watch ID that refers to the handler. The ID can be used to unregister the handler with <see cref="ClearWatch(long)"/>.</returns>
        Task<long?> WatchPosition(PositionOptions options = null);
        /// <summary>
        /// Handles the receipt of new positions. Fired whenever a handler is registered and the device's position changes.
        /// Invoked with the sender and the <see cref="GeolocationEventArgs"/>.
        /// </summary>
        event EventHandler<GeolocationEventArgs> WatchPositionReceived;
        /// <summary>
        /// A wrapper around the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/clearWatch"/> function,
        /// used to unregister a handler created with <see cref="WatchPosition(PositionOptions)"/>.
        /// </summary>
        /// <param name="watchId">The ID of the registered watch handler.</param>
        /// <returns>A task that represents the async clear operation.</returns>
        Task ClearWatch(long watchId);
    }
}