Class DistributionList

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A distribution list links a set of Rule(s) to a set of Recipient(s). When a Rule is violated each related Recipient will receive a notification of the kind defined by its RecipientType.

public class DistributionList : NameEntity, IEntity, IComparable, IIdentifiable

Inheritance

object

Entity

NameEntity

DistributionList

Implements

IEntity

IComparable

IIdentifiable

Derived

DistributionListSystem

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

NameEntity.Name

Entity.GetReadOnly()

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

DistributionList()

Initializes a new instance of the DistributionList class.Initializes a new instance of the DistributionList class.

public DistributionList()

DistributionList(Id?, string?, IList<Recipient>?, IList<Rule>?)

Initializes a new instance of the DistributionList class.Initializes a new instance of the DistributionList class.

public DistributionList(Id? id, string? name, IList<Recipient>? recipientList, IList<Rule>? ruleList)

Parameters

id Id

The Id.

name string

The name.

recipientList IList<Recipient>

The list Recipient(s) that will be notified when the Rule(s) are violated.

ruleList IList<Rule>

The list of Rule that when broken will notify the Recipient(s).

Properties

Recipients

Gets or sets a list of recipients that will be notified when the Rule(s) are violated.

public IList<Recipient>? Recipients { get; set; }

Property Value

IList<Recipient>

IList<T>

Rules

Gets or sets the list of <xref href="Geotab.Checkmate.ObjectModel.Exceptions.Rule" data-throw-if-not-resolved="false"></xref>(s) that the <xref href="Geotab.Checkmate.ObjectModel.Recipient" data-throw-if-not-resolved="false"></xref>(s)

will be notified of when broken.

public IList<Rule>? Rules { get; set; }

Property Value

IList<Rule>

IList<T>

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

SystemFromId(Id)

System from identifier.

public static DistributionList? SystemFromId(Id id)

Parameters

id Id

The identifier.

Returns

DistributionList

The DistributionList.