Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
WeatherAlert

WeatherAlert Class Reference

Constructors

Instance Methods

Constructors

new WeatherAlert(parameters)

Initializes an instance of 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.

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
summary String The desired Summary. {'string_min_length': 1}

weatherAlert.setTimeIssued(issued) ⇒ WeatherAlert

Set the TimeIssued

Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.

ParamTypeDescription
issued DateTime The desired TimeIssued.

weatherAlert.setTitle(title) ⇒ WeatherAlert

Set the Title

Kind: Instance method of WeatherAlert
Returns: WeatherAlert - The class instance for method chaining.

ParamTypeDescription
title String The desired Title. {'string_min_length': 1}
View on GitHub.com
Previous Section Next Section