Table of Contents

Interface INotificationMessage

Namespace
ArcanaDevelopment.adTempus.Shared.Notification
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Interface for classes that represent notification messages

public interface INotificationMessage

Properties

AdditionalHeaders

Additional headers to be added to SMTP messages.

string AdditionalHeaders { get; }

Property Value

string

Remarks

Specify headers in RFC822 format, with newlines between headers: header-name-1: value 1 header-name-2: value 2

AddressMode

The type of addressing to use for recipients.

MessageAddressMode AddressMode { get; }

Property Value

MessageAddressMode

Attachments

The attachments for the message

List<INotificationAttachment> Attachments { get; }

Property Value

List<INotificationAttachment>

BodyFormat

The format of the Message.

TextType BodyFormat { get; }

Property Value

TextType

ExecutionHistoryItemOID

The OID of the instance that generated the message.

Guid? ExecutionHistoryItemOID { get; }

Property Value

Guid?

ExecutionHistoryStepOID

The OID of the step instance that generated the message.

Guid? ExecutionHistoryStepOID { get; }

Property Value

Guid?

FromAddress

The e-mail address of the sender.

string FromAddress { get; }

Property Value

string

FromName

The name of the sender.

string FromName { get; }

Property Value

string

InstanceID

The instance ID of the instance that generated the message.

int? InstanceID { get; }

Property Value

int?

JobOID

The OID of the job that generated the message.

Guid? JobOID { get; }

Property Value

Guid?

Message

The body of the message.

string Message { get; }

Property Value

string

MessageSeverity

The notification severity of the message.

int MessageSeverity { get; }

Property Value

int

Remarks

Specify the severity from 1 (lowest) to 9 (highest). Default is 5. Notification Recipients may specify rules for notification based on the severity of the message.

MessageTimestamp

The timestamp of the message.

DateTimeOffset MessageTimestamp { get; }

Property Value

DateTimeOffset

Remarks

Defaults to the current time.

Recipients

The recipients for this message.

List<INotificationRecipient> Recipients { get; }

Property Value

List<INotificationRecipient>

StepNumber

The step number that generated the message.

int? StepNumber { get; }

Property Value

int?

Subject

The subject of the message.

string Subject { get; }

Property Value

string

Methods

Clone()

Creates a clone of the message

INotificationMessage Clone()

Returns

INotificationMessage