Class EmAlertNotificationType
A data type for an alert message
Inheritance
Implements
Inherited Members
Namespace: NiemTypes
Assembly: EidoLib.dll
Syntax
[DataContract]
public class EmAlertNotificationType : IEquatable<EmAlertNotificationType>
Properties
AlertAffectedLocation
A location affected by an alert NIEM reference is em:AlertAffectedLocation
Declaration
[DataMember(Name = "alertAffectedLocation")]
public List<EmAlertAffectedLocationType> AlertAffectedLocation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<EmAlertAffectedLocationType> | A location affected by an alert NIEM reference is em:AlertAffectedLocation |
AlertAugmentation
Additional information about an alert. NIEM reference is scr:AlertAugmentation
Declaration
[DataMember(Name = "alertAugmentation")]
public List<ScrAlertAugmentationType> AlertAugmentation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ScrAlertAugmentationType> | Additional information about an alert. NIEM reference is scr:AlertAugmentation |
AlertCategoryCode
A code value denoting the type of alert message NIEM reference is em:AlertCategoryCode
Declaration
[DataMember(Name = "alertCategoryCode")]
public List<EmAlertCategoryCodeType> AlertCategoryCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<EmAlertCategoryCodeType> | A code value denoting the type of alert message NIEM reference is em:AlertCategoryCode |
AlertEffectiveDateTime
A time of the information of the alert message NIEM reference is em:AlertEffectiveDateTime
Declaration
[DataMember(Name = "alertEffectiveDateTime")]
public List<NiemXsdateTime> AlertEffectiveDateTime { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsdateTime> | A time of the information of the alert message NIEM reference is em:AlertEffectiveDateTime |
AlertEventDetails
A container for all component parts of the info sub-element of the alert message. Multiple occurrences are permitted within a single alert NIEM reference is em:AlertEventDetails
Declaration
[DataMember(Name = "alertEventDetails")]
public List<EmAlertEventDetailsType> AlertEventDetails { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<EmAlertEventDetailsType> | A container for all component parts of the info sub-element of the alert message. Multiple occurrences are permitted within a single alert NIEM reference is em:AlertEventDetails |
AlertExpirationDateTime
A time of the information of the alert message expiring. If this item is not provided, each recipient is free to set its own policy as to when the message is no longer in effect NIEM reference is em:AlertExpirationDateTime
Declaration
[DataMember(Name = "alertExpirationDateTime")]
public List<NiemXsdateTime> AlertExpirationDateTime { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsdateTime> | A time of the information of the alert message expiring. If this item is not provided, each recipient is free to set its own policy as to when the message is no longer in effect NIEM reference is em:AlertExpirationDateTime |
AlertHandling
A code denoting the special handling of the alert message NIEM reference is em:AlertHandlingText
Declaration
[DataMember(Name = "alertHandling")]
public List<NcTextType> AlertHandling { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A code denoting the special handling of the alert message NIEM reference is em:AlertHandlingText |
AlertHandlingId
An identifier denoting the special handling of the alert message NIEM reference is em:AlertHandlingID
Declaration
[DataMember(Name = "alertHandlingId")]
public List<NcIdentificationType> AlertHandlingId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcIdentificationType> | An identifier denoting the special handling of the alert message NIEM reference is em:AlertHandlingID |
AlertHeadline
A text headline of the alert message. 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. 1 NIEM reference is em:AlertHeadlineText
Declaration
[DataMember(Name = "alertHeadline")]
public List<NcTextType> AlertHeadline { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A text headline of the alert message. 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. 1 NIEM reference is em:AlertHeadlineText |
AlertInstructionsDescription
A description of the recommended action to be taken by recipients of the alert message. 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 NIEM reference is em:AlertInstructionsDescriptionText
Declaration
[DataMember(Name = "alertInstructionsDescription")]
public List<NcTextType> AlertInstructionsDescription { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of the recommended action to be taken by recipients of the alert message. 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 NIEM reference is em:AlertInstructionsDescriptionText |
AlertReason
A text describing the reason the alert message was distributed NIEM reference is em:AlertReasonText
Declaration
[DataMember(Name = "alertReason")]
public List<NcTextType> AlertReason { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A text describing the reason the alert message was distributed NIEM reference is em:AlertReasonText |
AlertSupplementaryDigitalResource
A digital representation of an object NIEM reference is em:AlertSupplementaryDigitalResource
Declaration
[DataMember(Name = "alertSupplementaryDigitalResource")]
public List<EmAlertSupplementaryDigitalResourceType> AlertSupplementaryDigitalResource { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<EmAlertSupplementaryDigitalResourceType> | A digital representation of an object NIEM reference is em:AlertSupplementaryDigitalResource |
Augmentation
Additional information about a Alert. NIEM reference is j:AlertNotificationAugmentation
Declaration
[DataMember(Name = "augmentation")]
public List<JAlertNotificationAugmentationType> Augmentation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<JAlertNotificationAugmentationType> | Additional information about a Alert. NIEM reference is j:AlertNotificationAugmentation |
Context
emAlertNotificationType JSON-LD context
Declaration
[DataMember(Name = "@context")]
public EmAlertNotificationType.ContextEnum? Context { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<EmAlertNotificationType.ContextEnum> | emAlertNotificationType JSON-LD context |
Methods
Equals(EmAlertNotificationType)
Returns true if EmAlertNotificationType instances are equal
Declaration
public bool Equals(EmAlertNotificationType other)
Parameters
Type | Name | Description |
---|---|---|
EmAlertNotificationType | other | Instance of EmAlertNotificationType to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | Object to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |
Overrides
Operators
Equality(EmAlertNotificationType, EmAlertNotificationType)
Declaration
public static bool operator ==(EmAlertNotificationType left, EmAlertNotificationType right)
Parameters
Type | Name | Description |
---|---|---|
EmAlertNotificationType | left | |
EmAlertNotificationType | right |
Returns
Type | Description |
---|---|
System.Boolean |
Inequality(EmAlertNotificationType, EmAlertNotificationType)
Declaration
public static bool operator !=(EmAlertNotificationType left, EmAlertNotificationType right)
Parameters
Type | Name | Description |
---|---|---|
EmAlertNotificationType | left | |
EmAlertNotificationType | right |
Returns
Type | Description |
---|---|
System.Boolean |