Table of Contents

Class NotificationGroupMember

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

Represents a member of a NotificationGroup

public sealed class NotificationGroupMember : ADTObject
Inheritance
object
NotificationGroupMember

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.

EffectiveSchedules

Schedules that determine when this member is used

public EffectiveScheduleCollection EffectiveSchedules { get; }

Property Value

EffectiveScheduleCollection

Remarks

See the Remarks under NotificationGroupMember for more information.

Enabled

Indicates whether the recipient is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If a recipient is not enabled, no messages are sent to it

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.

Recipient

The NotificationRecipient

public NotificationRecipient Recipient { get; set; }

Property Value

NotificationRecipient

Remarks

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

ScheduleOverrideComparison

The comparison operator to use for overriding the EffectiveSchedules

public ComparisonOperator ScheduleOverrideComparison { get; set; }

Property Value

ComparisonOperator

Remarks

See the Remarks under NotificationGroupMember 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 NotificationGroupMember for more information.

UseForSeverity

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

public int UseForSeverity { get; set; }

Property Value

int

Remarks

See the Remarks under NotificationRecipient for more information.

UseForSeverityComparison

The comparison operator to use when determining whether to use this recipient 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 NotificationRecipient 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 NotificationGroupMember 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