WeatherAlert Class Reference
Constructors
Instance Methods
- getExpires() ⇒
DateTime - getRegions() ⇒
Array.<String> - getSeverity() ⇒
String - getSummary() ⇒
String - getTimeIssued() ⇒
DateTime - getTitle() ⇒
String - setExpires(expires) ⇒
WeatherAlert - setRegions(regions) ⇒
WeatherAlert - setSeverity(severity) ⇒
WeatherAlert - setSummary(summary) ⇒
WeatherAlert - setTimeIssued(issued) ⇒
WeatherAlert - setTitle(title) ⇒
WeatherAlert
Instance Methods
weatherAlert.getExpires() ⇒ DateTime
Get the Expires
Kind: Instance method of WeatherAlert
Returns: DateTime - the KEY_EXPIRES value
weatherAlert.getRegions() ⇒ Array.<String>
Get the Regions
Kind: Instance method of WeatherAlert
Returns: Array.<String> - the KEY_REGIONS value
weatherAlert.getSeverity() ⇒ String
Get the Severity
Kind: Instance method of WeatherAlert
Returns: String - the KEY_SEVERITY value
weatherAlert.getSummary() ⇒ String
Get the Summary
Kind: Instance method of WeatherAlert
Returns: String - the KEY_SUMMARY value
weatherAlert.getTimeIssued() ⇒ DateTime
Get the TimeIssued
Kind: Instance method of WeatherAlert
Returns: DateTime - the KEY_TIME_ISSUED value
weatherAlert.getTitle() ⇒ String
Get the Title
Kind: Instance method of WeatherAlert
Returns: String - the KEY_TITLE value
weatherAlert.setExpires(expires) ⇒ WeatherAlert
Set the Expires
Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| expires | DateTime |
The desired Expires. |
weatherAlert.setRegions(regions) ⇒ WeatherAlert
Set the Regions
Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| regions | Array.<String> |
The desired Regions. {'array_min_size': 1, 'array_max_size': 99, 'string_min_length': 1} |
weatherAlert.setSeverity(severity) ⇒ WeatherAlert
Set the Severity
Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| severity | String |
The desired Severity. {'string_min_length': 1} |
weatherAlert.setSummary(summary) ⇒ WeatherAlert
Set the Summary
Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| summary | String |
The desired Summary. {'string_min_length': 1} |