Base Entities
Weather-related functionalities are organized into distinct classes, each designed to encapsulate specific weather data.
The main classes include LocationForecast, Conditions, and Parameter. This guide provides a detailed explanation of each class and its purpose.
LocationForecast
The LocationForecast class retains data such as the forecast update datetime, the geographic location, and forecast data.
| Property | Type | Description |
|---|---|---|
updated | Time | Forecast update datetime (UTC) |
coord | Coordinates | Geographic location |
forecast | List<Conditions> | Forecast data |
Conditions
The Conditions class retains weather conditions for a given timestamp.
| Property | Type | Description |
|---|---|---|
type | String | For possible values see add ref[PredefinedParameterTypeValues] |
stamp | Time | Datetime for condition (UTC) |
image | Image | The conditions image |
description | String | Description translated according to the current SDK language |
daylight | EDaylight | Daylight condition |
params | List<Parameter> | Parameter list |
Parameter
The Parameter class contains weather parameter data.
| Property | Type | Description |
|---|---|---|
type | String | For possible values see below |
value | double | Value |
name | String | Name translated according to the current SDK language |
unit | String | Unit |
Parameter Type Values
The common values for Parameter::type are:
| Property | Description | Unit |
|---|---|---|
AirQuality | Air quality value | - |
DewPoint | Dew point value | °C |
FeelsLike | Feels like value | °C |
Humidity | Humidity value | % |
Pressure | Atmospheric pressure value | mb |
SunRise | Sun rise time | - |
SunSet | Sun set time | - |
Temperature | Current temperature value | °C |
UV | Ultra violet index value | - |
Visibility | Visibility distance | km |
WindDirection | Wind direction value | ° |
WindSpeed | Wind speed value | km/h |
TemperatureLow | Temperature low value | °C |
TemperatureHigh | Temperature high value | °C |
danger
The WeatherService may return data with varying property types, depending on data availability. A response might include only a subset of the values listed above.