Interface Alert

Hierarchy

  • Alert

Properties

affectedZones: string[]

URIs for zones affected by the alert. This is an API-specific extension field and is not part of the CAP specification.

areaDesc: string

A description of the area affected by the alert.

category: AlertCategory

The code denoting the category of the subject event of the alert message.

certainty: AlertCertainty
description: string

The text describing the subject event of the alert message.

effective: string

The effective time of the information of the alert message.

See

RFC 3339

ends?: null | string

The expected end time of the subject event of the alert message.

See

RFC 3339

event: string

The text denoting the type of the subject event of the alert message.

expires: string

The expiry time of the information of the alert message.

See

RFC 3339

geocode: AlertGeocode
headline?: null | string

The text headline of the alert message.

id: string

The identifier of the alert message.

instruction?: null | string

The text describing the recommended action to be taken by recipients of the alert message.

messageType: AlertMessageType
onset?: null | string

The expected time of the beginning of the subject event of the alert message.

See

RFC 3339

parameters: AlertParameters
references: AlertReference[]

Prior alerts that this alert updates or replaces.

response: AlertResponse
sender: string

Email address of the NWS webmaster.

senderName: string

The text naming the originator of the alert message.

sent: string

The time of the origination of the alert message.

See

RFC 3339

severity: AlertSeverity
status: AlertStatus
urgency: AlertUrgency

Generated using TypeDoc