Class alert

Root emelement for the CAP XML document. See "Common Alerting Protocol Version 1.2 OASIS Standard"

Inheritance

object

alert

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: CommonAlertingProtocol

Assembly: Ng911Lib.dll

Syntax

[Serializable]
public class alert

Fields

Any

Extension point.

Declaration

public XmlElement[] Any

Field Value

Type	Description
XmlElement[]

Properties

addresses

The group listing of intended recipients of the alert message. Conditional.

Declaration

public string addresses { get; set; }

Property Value

Type	Description
string

Remarks

1. Required when scope is “Private”, optional when scope is “Public” or “Restricted”.
2. Each recipient SHALL be identified by an identifier or an address.
3. Multiple space-delimited addresses MAY be included. Addresses including whitespace MUST be enclosed in double-quotes.

code

The code denoting the special handling of the alert message. Optional.

Declaration

public List<string> code { get; set; }

Property Value

Type	Description
List<string>

Remarks

1. Any user-defined flag or special code used to flag the alert message for special handling.
2. Multiple instances MAY occur.

identifier

The identifier of the alert message. Set to a number or string uniquely identifying this message, assigned by the sender. Required.

Declaration

public string identifier { get; set; }

Property Value

Type	Description
string

incidents

The group listing naming the referent incident(s) of the alert message. Optional.

Declaration

public string incidents { get; set; }

Property Value

Type	Description
string

Remarks

1. Used to collate multiple messages referring to different aspects of the same incident.
2. If multiple incident identifiers are referenced, they SHALL be separated by whitespace. Incident names including whitespace SHALL be surrounded by double-quotes.

info

Information pertaining to the alert. Optional.

Declaration

public List<alertInfo> info { get; set; }

Property Value

Type	Description
List<alertInfo>

msgType

The code denoting the nature of the alert message. Required.

Declaration

public alertMsgType msgType { get; set; }

Property Value

Type	Description
alertMsgType

note

The text describing the purpose or significance of the alert message. Optional.

Declaration

public string note { get; set; }

Property Value

Type	Description
string

references

The group listing identifying earlier message(s) referenced by the alert message. Optional.

Declaration

public string references { get; set; }

Property Value

Type	Description
string

Remarks

1. The extended message identifier(s) (in the form sender,identifier,sent) of an earlier CAP message or messages referenced by this one.
2. If multiple messages are referenced, they SHALL be separated by whitespace.

restriction

The text describing the rule for limiting distribution of the restricted alert message. Used when the scope value is "Restricted". Conditional.

Declaration

public string restriction { get; set; }

Property Value

Type	Description
string

scope

The code denoting the intended distribution of the alert message. Required.

Declaration

public alertScope scope { get; set; }

Property Value

Type	Description
alertScope

sender

The identifier of the sender of the alert message. Identifies the originator of this alert. Guaranteed by assigner to be unique globally; e.g., may be based on an Internet domain name. Required.

Declaration

public string sender { get; set; }

Property Value

Type	Description
string

sent

The time and date of the origination of the alert message. Required.

Declaration

public DateTime sent { get; set; }

Property Value

Type	Description
DateTime

source

The particular source of this alert; e.g., an operator or a specific device.

Declaration

public string source { get; set; }

Property Value

Type	Description
string

status

The code denoting the appropriate handling of the alert message. Required.

Declaration

public alertStatus status { get; set; }

Property Value

Type	Description
alertStatus