navigation-ux-weather-api/com.mapbox.dash.sdk.weather.api/WeatherApi

WeatherApi

interface WeatherApi

Functions

Link copied to clipboard
abstract suspend fun getCondition(location: Point, systemOfMeasurement: WeatherSystemOfMeasurement = WeatherSystemOfMeasurement.Imperial): Result<WeatherCondition>

Retrieves conditions at the requested location.

Link copied to clipboard
abstract suspend fun getForecast(location: Point, systemOfMeasurement: WeatherSystemOfMeasurement = WeatherSystemOfMeasurement.Imperial): Result<List<WeatherForecastItem>>

Retrieves a list of forecast conditions at the requested location.

Link copied to clipboard
abstract suspend fun getWeatherAlerts(location: Point): Result<List<WeatherAlert>>

Retrieves a list of severe weather alerts for the given location. The attribution phrase must display: “Issued by - , , , ”.