Table of Contents

Class NotificationTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class NotificationTask : Task
Inheritance
object
NotificationTask

Properties

AdditionalHeaders

Optional additional headers to be added to SMTP notification messages.

public string AdditionalHeaders { get; set; }

Property Value

string

Remarks

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

AdditionalRecipients

Additional recipients to receive the message.

public EmailRecipientList AdditionalRecipients { get; }

Property Value

EmailRecipientList

Remarks

AdditionalRecipients allows the message to be sent to ad-hoc recipients not defined as Notification Recipients in adTempus. Separate recipients with semicolons. Each recipient should use one of these forms: [email protected] Recipient Name <[email protected]&gt;

Attachments

public FileCaptureSpecCollection Attachments { get; }

Property Value

FileCaptureSpecCollection

BodyFormat

public TextType BodyFormat { get; set; }

Property Value

TextType

BodySourceFile

public string BodySourceFile { get; set; }

Property Value

string

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

FromAddress

Optional override of the default return address for notification messages.

public string FromAddress { get; set; }

Property Value

string

FromName

Optional override of the default sender name for notification messages.

public string FromName { get; set; }

Property Value

string

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

MessageAddressMode

public MessageAddressMode MessageAddressMode { get; set; }

Property Value

MessageAddressMode

NotificationMessage

public string NotificationMessage { get; set; }

Property Value

string

NotificationSubject

public string NotificationSubject { get; set; }

Property Value

string

Options

public NotificationTaskOptions Options { get; set; }

Property Value

NotificationTaskOptions

Recipients

public NotificationRecipientCollection Recipients { get; }

Property Value

NotificationRecipientCollection

SendConsoleOutput

public bool SendConsoleOutput { get; set; }

Property Value

bool

Severity

public int Severity { get; set; }

Property Value

int

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members