One Logo Pool Ball
WeatherKit · IOS API REFERENCE

WeatherAlert

struct · iOS 16.0+ · SDK 27.1

struct WeatherAlert

A weather alert issued for the requested location by a governmental authority. Weather alerts often contains severe weather information; however, not all alerts are severe. Alerts may or may not contain localized descriptions, depending on what is available from the source. Due to data source restrictions, information contained is served raw.

Members (12)

get · iOS 16.0+

detailsURL

TypeScript
get detailsURL(): string
Swift declaration
var detailsURL: URL

The site for more details about the weather alert. This is required for attribution.

set · iOS 16.0+

detailsURL

TypeScript
set detailsURL(value: string)
Swift declaration
var detailsURL: URL

The site for more details about the weather alert. This is required for attribution.

get · iOS 16.0+

region

TypeScript
get region(): (string) | null
Swift declaration
var region: String?

The name of the affected area.

set · iOS 16.0+

region

TypeScript
set region(value: (string) | null)
Swift declaration
var region: String?

The name of the affected area.

get · iOS 16.0+

source

TypeScript
get source(): string
Swift declaration
var source: String

The name of the source issuing the weather alert. This is required for attribution.

set · iOS 16.0+

source

TypeScript
set source(value: string)
Swift declaration
var source: String

The name of the source issuing the weather alert. This is required for attribution.

get · iOS 16.0+

summary

TypeScript
get summary(): string
Swift declaration
var summary: String

The summary of the event type. The summary may or may not contain localized descriptions, depending on what is available from the source.

set · iOS 16.0+

summary

TypeScript
set summary(value: string)
Swift declaration
var summary: String

The summary of the event type. The summary may or may not contain localized descriptions, depending on what is available from the source.

get · iOS 16.0+

metadata

TypeScript
get metadata(): WeatherMetadata
Swift declaration
var metadata: WeatherMetadata

Descriptive information about the weather alert data.

set · iOS 16.0+

metadata

TypeScript
set metadata(value: WeatherMetadata)
Swift declaration
var metadata: WeatherMetadata

Descriptive information about the weather alert data.

get · iOS 16.0+

severity

TypeScript
get severity(): WeatherSeverity
Swift declaration
var severity: WeatherSeverity

The severity of the weather alert.

set · iOS 16.0+

severity

TypeScript
set severity(value: WeatherSeverity)
Swift declaration
var severity: WeatherSeverity

The severity of the weather alert.

Skipped declarations

No declarations were skipped in this snapshot.

All WeatherKit types →