WeatherServiceData Class Reference
Constructors
Instance Methods
- getAlerts() ⇒
Array.<WeatherAlert> - getCurrentForecast() ⇒
WeatherData - getHourlyForecast() ⇒
Array.<WeatherData> - getLocation() ⇒
LocationDetails - getMinuteForecast() ⇒
Array.<WeatherData> - getMultidayForecast() ⇒
Array.<WeatherData> - setAlerts(alerts) ⇒
WeatherServiceData - setCurrentForecast(forecast) ⇒
WeatherServiceData - setHourlyForecast(forecast) ⇒
WeatherServiceData - setLocation(location) ⇒
WeatherServiceData - setMinuteForecast(forecast) ⇒
WeatherServiceData - setMultidayForecast(forecast) ⇒
WeatherServiceData
Instance Methods
weatherServiceData.getAlerts() ⇒ Array.<WeatherAlert>
Get the Alerts
Kind: Instance method of WeatherServiceData
Returns: Array.<WeatherAlert> - the KEY_ALERTS value
weatherServiceData.getCurrentForecast() ⇒ WeatherData
Get the CurrentForecast
Kind: Instance method of WeatherServiceData
Returns: WeatherData - the KEY_CURRENT_FORECAST value
weatherServiceData.getHourlyForecast() ⇒ Array.<WeatherData>
Get the HourlyForecast
Kind: Instance method of WeatherServiceData
Returns: Array.<WeatherData> - the KEY_HOURLY_FORECAST value
weatherServiceData.getLocation() ⇒ LocationDetails
Get the Location
Kind: Instance method of WeatherServiceData
Returns: LocationDetails - the KEY_LOCATION value
weatherServiceData.getMinuteForecast() ⇒ Array.<WeatherData>
Get the MinuteForecast
Kind: Instance method of WeatherServiceData
Returns: Array.<WeatherData> - the KEY_MINUTE_FORECAST value
weatherServiceData.getMultidayForecast() ⇒ Array.<WeatherData>
Get the MultidayForecast
Kind: Instance method of WeatherServiceData
Returns: Array.<WeatherData> - the KEY_MULTIDAY_FORECAST value
weatherServiceData.setAlerts(alerts) ⇒ WeatherServiceData
Set the Alerts
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| alerts | Array.<WeatherAlert> |
This array should be ordered with the first object being the current day - The desired Alerts. {'array_min_size': 1, 'array_max_size': 10} |
weatherServiceData.setCurrentForecast(forecast) ⇒ WeatherServiceData
Set the CurrentForecast
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| forecast | WeatherData |
The desired CurrentForecast. |
weatherServiceData.setHourlyForecast(forecast) ⇒ WeatherServiceData
Set the HourlyForecast
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| forecast | Array.<WeatherData> |
The desired HourlyForecast. {'array_min_size': 1, 'array_max_size': 96} |
weatherServiceData.setLocation(location) ⇒ WeatherServiceData
Set the Location
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| location | LocationDetails |
The desired Location. |
weatherServiceData.setMinuteForecast(forecast) ⇒ WeatherServiceData
Set the MinuteForecast
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| forecast | Array.<WeatherData> |
The desired MinuteForecast. {'array_min_size': 15, 'array_max_size': 60} |
weatherServiceData.setMultidayForecast(forecast) ⇒ WeatherServiceData
Set the MultidayForecast
Kind: Instance method of WeatherServiceData
Returns: WeatherServiceData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| forecast | Array.<WeatherData> |
The desired MultidayForecast. {'array_min_size': 1, 'array_max_size': 30} |