Table of Contents

Class NotificationGroup

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

A group of NotificationRecipients

public sealed class NotificationGroup : NotificationRecipient
Inheritance
object
NotificationGroup

Remarks

The Members collection defines the members of the group, with optional rules for when each member should receive messages sent to the group

Properties

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.

Members

The members of the group

public NotificationGroupMemberCollection Members { get; }

Property Value

NotificationGroupMemberCollection

Remarks

A group's members may be NotificationIndividuals or other Notification Groups.

By default any message sent to the NotificationGroup is sent to all of its Members, but each member may optionally have rules determining which messages are delivered to it, based on the message severity or on a schedule (see NotificationGroupMember for more information).

To add a member to a group, create a new NotificationGroupMember, set the Recipient to the recipient, and add the NotificationGroupMember to the Members collection.

Removing a member of the collection only removes the recipient from the group; it does not delete the recipient.

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