Class alertInfo

Class for the info elements of the alert document.

Inheritance
object
alertInfo
Inherited Members
Namespace: CommonAlertingProtocol
Assembly: Ng911Lib.dll
Syntax
[Serializable]
public class alertInfo

Constructors

| Edit this page View Source

alertInfo()

Default constructor.

Declaration
public alertInfo()

Properties

| Edit this page View Source

Effective

Gets or sets the optional effective time of the information of the alert message.

Declaration
public DateTime Effective { get; set; }
Property Value
Type Description
DateTime
| Edit this page View Source

Expires

Gets or sets expiry time of the information of the alert message (OPTIONAL).

Declaration
public DateTime Expires { get; set; }
Property Value
Type Description
DateTime
| Edit this page View Source

Onset

Gets or sets the expected time of the beginning of the subject event of the alert message (OPTIONAL).

Declaration
public DateTime Onset { get; set; }
Property Value
Type Description
DateTime
| Edit this page View Source

area

Description of the affected area of the alert (OPTIONAL).

Declaration
public List<alertInfoArea> area { get; set; }
Property Value
Type Description
List<alertInfoArea>
| Edit this page View Source

audience

The text describing the intended audience of the alert message (OPTIONAL)

Declaration
public string audience { get; set; }
Property Value
Type Description
string
| Edit this page View Source

category

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

Declaration
public List<alertInfoCategory> category { get; set; }
Property Value
Type Description
List<alertInfoCategory>
| Edit this page View Source

certainty

The code denoting the certainty of the subject event of the alert message (REQUIRED)

Declaration
public alertInfoCertainty certainty { get; set; }
Property Value
Type Description
alertInfoCertainty
| Edit this page View Source

contact

The text describing the contact for follow-up and confirmation of the alert message (OPTIONAL)

Declaration
public string contact { get; set; }
Property Value
Type Description
string
| Edit this page View Source

description

The text describing the subject event of the alert message (OPTIONAL)

Declaration
public string description { get; set; }
Property Value
Type Description
string
Remarks

An extended human readable description of the hazard or event that occasioned this message.

| Edit this page View Source

effective

The effective time of the information of the alert message (OPTIONAL).

Declaration
public DateTime effective { get; set; }
Property Value
Type Description
DateTime
See Also
| Edit this page View Source

effectiveSpecified

Set to true if the effective date element has been set.

Declaration
public bool effectiveSpecified { get; set; }
Property Value
Type Description
bool
See Also
| Edit this page View Source

event

The text denoting the type of the subject event of the alert message (REQUIRED)

Declaration
public string @event { get; set; }
Property Value
Type Description
string
| Edit this page View Source

eventCode

A system-specific code identifying the event type of the alert message (OPTIONAL)

Declaration
public List<alertInfoEventCode> eventCode { get; set; }
Property Value
Type Description
List<alertInfoEventCode>
| Edit this page View Source

expires

The expiry time of the information of the alert message (OPTIONAL)

Declaration
public DateTime expires { get; set; }
Property Value
Type Description
DateTime
See Also
| Edit this page View Source

expiresSpecified

Set to true if the expires date has been set.

Declaration
public bool expiresSpecified { get; set; }
Property Value
Type Description
bool
See Also
| Edit this page View Source

headline

The text headline of the alert message (OPTIONAL).

Declaration
public string headline { get; set; }
Property Value
Type Description
string
Remarks

A brief human-readable headline. Note that some displays (for example, short messaging service devices) may only present this headline; it SHOULD be made as direct and actionable as possible while remaining short. 160 characters MAY be a useful target limit for headline length.

| Edit this page View Source

instruction

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

Declaration
public string instruction { get; set; }
Property Value
Type Description
string
Remarks

An extended human readable instruction to targeted recipients. If different instructions are intended for different recipients, they should be represented by use of multiple info blocks.

| Edit this page View Source

language

The code denoting the language of the info sub-element of the alert message (OPTIONAL).

  1. Code Values: Natural language identifier per [RFC 3066].
  2. If not present, an implicit default value of "en-US" SHALL be assumed.
  3. A null value in this element SHALL be considered equivalent to “en-US.”
Declaration
public string language { get; set; }
Property Value
Type Description
string
| Edit this page View Source

onset

The expected time of the beginning of the subject event of the alert message (OPTIONAL).

Declaration
public DateTime onset { get; set; }
Property Value
Type Description
DateTime
See Also
| Edit this page View Source

onsetSpecified

Set to true if the onset date element has been set.

Declaration
public bool onsetSpecified { get; set; }
Property Value
Type Description
bool
See Also
| Edit this page View Source

parameter

A system-specific additional parameter associated with the alert message (OPTIONAL)

Declaration
public List<alertInfoParameter> parameter { get; set; }
Property Value
Type Description
List<alertInfoParameter>
| Edit this page View Source

resource

Contains all the infomation about resources (OPTIONAL).

Declaration
public List<alertInfoResource> resource { get; set; }
Property Value
Type Description
List<alertInfoResource>
Remarks

Refers to an additional file with supplemental information related to this info element; e.g., an image or audio file.

| Edit this page View Source

responseType

The code denoting the type of action recommended for the target audience (OPTIONAL)

Declaration
public List<alertInfoResponseType> responseType { get; set; }
Property Value
Type Description
List<alertInfoResponseType>
| Edit this page View Source

senderName

The text naming the originator of the alert message (OPTIONAL). The human-readable name of the agency or authority issuing this alert.

Declaration
public string senderName { get; set; }
Property Value
Type Description
string
| Edit this page View Source

severity

The code denoting the severity of the subject event of the alert message (REQUIRED)

Declaration
public alertInfoSeverity severity { get; set; }
Property Value
Type Description
alertInfoSeverity
| Edit this page View Source

urgency

The code denoting the urgency of the subject event of the alert message (REQUIRED). The urgency, severity, and certainty elements collectively distinguish less emphatic from more emphatic messages.

Declaration
public alertInfoUrgency urgency { get; set; }
Property Value
Type Description
alertInfoUrgency
| Edit this page View Source

web

The identifier of the hyperlink associating additional information with the alert message (OPTIONAL).

Declaration
public string web { get; set; }
Property Value
Type Description
string
Remarks

A full, absolute URI for an HTML page or other text resource with additional or reference information regarding this alert.