Table of Contents

Class NotificationIndividual

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

An individual notification recipient

public sealed class NotificationIndividual : NotificationRecipient
Inheritance
object
NotificationIndividual

Remarks

A NotificationIndividual represents a recipient that has one or more addresses that notification messages are delivered to. This could be an individual user or a group mailbox maintained outside of adTempus. Within adTempus NotificationGroups can be used to send notifications to multiple recipients.

Each recipient has one or more Addresses, each of which can be for a different notification type. For example, a user may be configured to receive notification by email and by text message by adding an Address for each.

By default any message sent to the NotificationIndividual is sent to all of its Addresses, but each Address may optionally have rules determining which messages are delivered to it, based on the message severity or on a schedule.

Properties

Addresses

The addresses for this recipient

public NotificationAddressCollection Addresses { get; }

Property Value

NotificationAddressCollection

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.

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.

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.

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

See Also

NotificationAddress
NotificationGroup