Interface ICoordinatesResolver

Namespace

XENBIT.ResQueServe.Abstractions.Interfaces

Assembly

RQS.Abstractions.dll

Defines methods for resolving geographic coordinates for a specified location. Multiple ICoordinatesResolver instances may be used to obtain the best match.

[TypeScriptUnavailable]
public interface ICoordinatesResolver : IPrioritizedService

Inherited Members

IPrioritizedService.Priority

Properties

IsUsingCachedData

If the implementation uses cached data, this property will be true.

bool IsUsingCachedData { get; }

Property Value

bool

Methods

GetCoordinatesAsync(IAddress, string?)

Asynchronously retrieves the coordinates for a given address.

Task<IGeocodingResult?> GetCoordinatesAsync(IAddress address, string? houseNumber = null)

Parameters

address IAddress

The address for which to resolve coordinates.

houseNumber string

The house number to further specify the address, if available. Optional.

Returns

Task<IGeocodingResult>

A task representing the asynchronous operation, with a result of IGeocodingResult if resolved; otherwise, null.

GetManyCoordinatesAsync(IAddress, string?)

Asynchronously retrieves multiple possible geocoding results for a given address.

Task<IEnumerable<IGeocodingResult>?> GetManyCoordinatesAsync(IAddress address, string? houseNumber = null)

Parameters

address IAddress

The address for which to resolve multiple coordinates.

houseNumber string

The house number to further specify the address, if available. Optional.

Returns

Task<IEnumerable<IGeocodingResult>>

A task representing the asynchronous operation, with a result of an enumerable collection of IGeocodingResult instances.