Table of Contents

Class NotificationAddress

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Represents a delivery address for a NotificationRecipient

public sealed class NotificationAddress : ADTObject
Inheritance
object
NotificationAddress

Properties

AddressType

The type of address

public NotificationAddressType AddressType { get; set; }

Property Value

NotificationAddressType

Remarks

The AddressType determines the mechanism by which the message is delivered.

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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.

EffectiveSchedules

Schedules that determine when this address is used

public EffectiveScheduleCollection EffectiveSchedules { get; }

Property Value

EffectiveScheduleCollection

Remarks

See the Remarks under NotificationAddress for more information.

Enabled

Determines whether the address is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If an address is disable it is ignored when messages are sent to the recipient.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

MaximumMessageLength

The maximum length (in bytes) for messages sent to this address

public int MaximumMessageLength { get; set; }

Property Value

int

Remarks

Set to 0 (the default) for no limit.

If a limit is set, messages longer than the limit are truncated.

RecipientAddress

The address

public string RecipientAddress { get; set; }

Property Value

string

Remarks

The address must be in the correct format for the AddressType. For example, if AddressType is SMTP it must be a valid email address.

ScheduleOverrideComparison

The comparison operator to use for overriding the EffectiveSchedules

public ComparisonOperator ScheduleOverrideComparison { get; set; }

Property Value

ComparisonOperator

Remarks

See the Remarks under NotificationAddress for more information.

ScheduleOverrideSeverity

The severity threshold to use for overriding the EffectiveSchedules

public int ScheduleOverrideSeverity { get; set; }

Property Value

int

Remarks

See the Remarks under NotificationAddress for more information.

SendOptions

Additional options to use when sending

[ReservedForFutureUse]
public int SendOptions { get; set; }

Property Value

int

Remarks

Reserved. Set to 0.

ServiceProvider

The MessagingServiceProvider to use for this address, if a specific provider is required

public MessagingServiceProvider ServiceProvider { get; set; }

Property Value

MessagingServiceProvider

Remarks

If this address requires a particular MessagingServiceProvider specify the provider here. Otherwise, set to null and adTempus will try all available providers that can serve this AddressType. For example, if SMS notification to this mobile device needs to be delivered through a specific SMS provider, specify the provider here. Otherwise adTempus will try all of the configured SMS providers.

UseForSeverity

The severity threshold to use when determining whether to use this address for a notification message

public int UseForSeverity { get; set; }

Property Value

int

Remarks

See the Remarks under NotificationAddress for more information.

UseForSeverityComparison

The comparison operator to use when determining whether to use this address for a notification message

public ComparisonOperator UseForSeverityComparison { get; set; }

Property Value

ComparisonOperator

Remarks

Set to Unspecified (the default) to not use severity filtering.

See the Remarks under NotificationAddress for more information.

UseSchedules

Indicates whether EffectiveSchedules are used

public bool UseSchedules { get; set; }

Property Value

bool

Remarks

If false, the EffectiveSchedules are ignored.

See the Remarks under NotificationAddress for more information.

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members