Class AlertMessage
An acknowledge-able message that is used to provide information and alerting about the state of an Asset
Inherited Members
Namespace: IAI.DT.DataModel
Assembly: IAI.DT.DataModel.dll
Syntax
public class AlertMessage
Constructors
AlertMessage(string, DateTime, string, string, MessageSeverity, string?)
Constructor
Declaration
public AlertMessage(string messageId, DateTime createdAt, string source, string content, MessageSeverity severity, string? id = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | messageId | The message identifier MessageId |
| DateTime | createdAt | The message creation date CreatedAt |
| string | source | The source of the message Source |
| string | content | The message content Content |
| MessageSeverity | severity | The severity of the message Severity |
| string | id | The ID of the message, nullable to allow creation of new guids Id |
Properties
AcknowledgedAt
The date and time that the user AcknowledgedByUser acknowledged the message.
Declaration
public DateTime? AcknowledgedAt { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? |
AcknowledgedByUser
The signed in user id of the user who acknowledged the message
Declaration
public string? AcknowledgedByUser { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Content
The message test to be displayed or reported to the user.
Declaration
public string Content { get; }
Property Value
| Type | Description |
|---|---|
| string |
CreatedAt
The data and time at which the message was created.
Declaration
public DateTime CreatedAt { get; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Id
The unique identifier of this message instance
Declaration
public string Id { get; }
Property Value
| Type | Description |
|---|---|
| string |
IsAcknowledged
A flag indicating if the message has been acknowledged.
Declaration
public bool IsAcknowledged { get; }
Property Value
| Type | Description |
|---|---|
| bool |
MessageId
The identifier of the message of the form <Prefix><Code>
Declaration
public string MessageId { get; }
Property Value
| Type | Description |
|---|---|
| string |
Severity
The severity associated with the message MessageSeverity
Declaration
public MessageSeverity Severity { get; }
Property Value
| Type | Description |
|---|---|
| MessageSeverity |
Source
The name of the software element which created the message
Declaration
public string Source { get; }
Property Value
| Type | Description |
|---|---|
| string |