Class EmNotificationType

A data type for the function of the message

Inheritance

System.Object

NcActivityType

EmNotificationType

Implements

System.IEquatable<NcActivityType>

System.IEquatable<EmNotificationType>

Inherited Members

NcActivityType.Identification

NcActivityType.Category

NcActivityType.Description

NcActivityType.Name

NcActivityType.Status

NcActivityType.Reason

NcActivityType.Disposition

NcActivityType.ContactEntity

NcActivityType.Date

NcActivityType.Equals(NcActivityType)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NiemTypes

Assembly: EidoLib.dll

Syntax

[DataContract]
public class EmNotificationType : NcActivityType, IEquatable<NcActivityType>, IEquatable<EmNotificationType>

Properties

Alarm

An event that begins when an assembly of equipment or a device installed in or for commercial or residential premises, or other property, is triggered to transmit a signal, visibly, audibly, electronically, mechanically, or otherwise, to indicate NIEM reference is em:AlarmNotification

Declaration

[DataMember(Name = "alarm")]
public List<EmAlarmNotificationType> Alarm { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmAlarmNotificationType>	An event that begins when an assembly of equipment or a device installed in or for commercial or residential premises, or other property, is triggered to transmit a signal, visibly, audibly, electronically, mechanically, or otherwise, to indicate NIEM reference is em:AlarmNotification

Alert

A notification of an incident or threat that may require a coordinated response or action. A type of NOTIFICATION NIEM reference is em:AlertNotification

Declaration

[DataMember(Name = "alert")]
public List<EmAlertNotificationType> Alert { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmAlertNotificationType>	A notification of an incident or threat that may require a coordinated response or action. A type of NOTIFICATION NIEM reference is em:AlertNotification

Augmentation

Additional information about a Notification. NIEM reference is j:NotificationAugmentation

Declaration

[DataMember(Name = "augmentation")]
public List<JNotificationAugmentationType> Augmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<JNotificationAugmentationType>	Additional information about a Notification. NIEM reference is j:NotificationAugmentation

CategoryCode

An element for possible notification message types NIEM reference is em:NotificationCategoryCode

Declaration

[DataMember(Name = "categoryCode")]
public List<EmNotificationCategoryCodeType> CategoryCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotificationCategoryCodeType>	An element for possible notification message types NIEM reference is em:NotificationCategoryCode

Confidentiality

A textual details about the confidentiality of a notification NIEM reference is em:NotificationConfidentialityText

Declaration

[DataMember(Name = "confidentiality")]
public List<NcTextType> Confidentiality { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A textual details about the confidentiality of a notification NIEM reference is em:NotificationConfidentialityText

Context

emNotificationType JSON-LD context

Declaration

[DataMember(Name = "@context")]
public EmNotificationType.ContextEnum? Context { get; set; }

Property Value

Type	Description
System.Nullable<EmNotificationType.ContextEnum>	emNotificationType JSON-LD context

DistributionScope

A set of details about the intended level of distribution of the notification message NIEM reference is em:NotificationDistributionScope

Declaration

[DataMember(Name = "distributionScope")]
public List<EmNotificationDistributionScopeType> DistributionScope { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotificationDistributionScopeType>	A set of details about the intended level of distribution of the notification message NIEM reference is em:NotificationDistributionScope

FunctionCategoryCode

A code value denoting the nature of the notification message NIEM reference is em:NotificationFunctionCategoryCode

Declaration

[DataMember(Name = "functionCategoryCode")]
public List<EmNotificationFunctionCategoryCodeType> FunctionCategoryCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotificationFunctionCategoryCodeType>	A code value denoting the nature of the notification message NIEM reference is em:NotificationFunctionCategoryCode

General

An element for representing a generalized notification to broadcast NIEM reference is em:GeneralNotification

Declaration

[DataMember(Name = "general")]
public List<EmGeneralNotificationType> General { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmGeneralNotificationType>	An element for representing a generalized notification to broadcast NIEM reference is em:GeneralNotification

Incident

An element for representing an incident NIEM reference is em:IncidentNotification

Declaration

[DataMember(Name = "incident")]
public List<EmIncidentNotificationType> Incident { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmIncidentNotificationType>	An element for representing an incident NIEM reference is em:IncidentNotification

Keyword

A significant word or phrase related to the notification message. It may determine message routing decisions NIEM reference is em:NotificationKeywordText

Declaration

[DataMember(Name = "keyword")]
public List<NcTextType> Keyword { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A significant word or phrase related to the notification message. It may determine message routing decisions NIEM reference is em:NotificationKeywordText

LanguageCode

A code denoting the primary language used in the payload or body of the notification message NIEM reference is em:NotificationLanguageCode

Declaration

[DataMember(Name = "languageCode")]
public List<Iso6393LanguageCodeType> LanguageCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Iso6393LanguageCodeType>	A code denoting the primary language used in the payload or body of the notification message NIEM reference is em:NotificationLanguageCode

MessageStatusCode

An element for possible message status types indicating outcome of notification transmission NIEM reference is em:NotificationMessageStatusCode

Declaration

[DataMember(Name = "messageStatusCode")]
public List<EmNotificationMessageStatusCodeType> MessageStatusCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotificationMessageStatusCodeType>	An element for possible message status types indicating outcome of notification transmission NIEM reference is em:NotificationMessageStatusCode

NotificationId

An identifier of the alert message. A number or string uniquely identifying this message, assigned by the sender NIEM reference is em:NotificationID

Declaration

[DataMember(Name = "notificationId")]
public List<NcIdentificationType> NotificationId { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcIdentificationType>	An identifier of the alert message. A number or string uniquely identifying this message, assigned by the sender NIEM reference is em:NotificationID

OperationalStatus

An element for an emergency operation notification NIEM reference is em:OperationalStatusNotification

Declaration

[DataMember(Name = "operationalStatus")]
public List<EmOperationalStatusNotificationType> OperationalStatus { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmOperationalStatusNotificationType>	An element for an emergency operation notification NIEM reference is em:OperationalStatusNotification

Originator

An element for originator of the notification NIEM reference is em:NotificationOriginator

Declaration

[DataMember(Name = "originator")]
public List<EmNotifierType> Originator { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotifierType>	An element for originator of the notification NIEM reference is em:NotificationOriginator

Recipient

An element for recipient of the notification NIEM reference is em:NotificationRecipient

Declaration

[DataMember(Name = "recipient")]
public List<EmNotifierType> Recipient { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotifierType>	An element for recipient of the notification NIEM reference is em:NotificationRecipient

SourceId

An identifier for the particular source of this alert; e.g., an operator or a specific device NIEM reference is em:NotificationSourceID

Declaration

[DataMember(Name = "sourceId")]
public List<NcIdentificationType> SourceId { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcIdentificationType>	An identifier for the particular source of this alert; e.g., an operator or a specific device NIEM reference is em:NotificationSourceID

SourceName

A name, in text, of particular source of this alert; e.g., an operator or a specific device NIEM reference is em:NotificationSourceNameText

Declaration

[DataMember(Name = "sourceName")]
public List<NcTextType> SourceName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A name, in text, of particular source of this alert; e.g., an operator or a specific device NIEM reference is em:NotificationSourceNameText

TargetLocation

A notification target location NIEM reference is em:NotificationTargetLocation

Declaration

[DataMember(Name = "targetLocation")]
public List<EmNotificationTargetLocationType> TargetLocation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmNotificationTargetLocationType>	A notification target location NIEM reference is em:NotificationTargetLocation

UnitLogoff

An element to represent that the specified units are being logged off NIEM reference is em:UnitLogoffNotification

Declaration

[DataMember(Name = "unitLogoff")]
public List<EmUnitLogoffNotificationType> UnitLogoff { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmUnitLogoffNotificationType>	An element to represent that the specified units are being logged off NIEM reference is em:UnitLogoffNotification

UnitLogon

An element to represent that the specified units are being logged on NIEM reference is em:UnitLogonNotification

Declaration

[DataMember(Name = "unitLogon")]
public List<EmUnitLogonNotificationType> UnitLogon { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EmUnitLogonNotificationType>	An element to represent that the specified units are being logged on NIEM reference is em:UnitLogonNotification

Methods

Equals(EmNotificationType)

Returns true if EmNotificationType instances are equal

Declaration

public bool Equals(EmNotificationType other)

Parameters

Type	Name	Description
EmNotificationType	other	Instance of EmNotificationType 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

NcActivityType.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

NcActivityType.GetHashCode()

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

NcActivityType.ToString()

Operators

Equality(EmNotificationType, EmNotificationType)

Declaration

public static bool operator ==(EmNotificationType left, EmNotificationType right)

Parameters

Type	Name	Description
EmNotificationType	left
EmNotificationType	right

Returns

Type	Description
System.Boolean

Inequality(EmNotificationType, EmNotificationType)

Declaration

public static bool operator !=(EmNotificationType left, EmNotificationType right)

Parameters

Type	Name	Description
EmNotificationType	left
EmNotificationType	right

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>

System.IEquatable<T>