Class Recipient

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The recipient for a specific notification. A recipient is linked to Rule(s) via a DistributionList. When a Rule is violated the DistributionList linked recipient receives a notification. The type of recipient is defined by it's RecipientType. Not all properties of this object will have a value at the same time they are dependent on the RecipientType. Recipient is represented by the string "NoRecipientId" where there is no recipient.

public class Recipient : Entity, IEntity, IComparable, IIdentifiable

Inheritance

object

Entity

Recipient

Implements

IEntity

IComparable

IIdentifiable

Derived

NoRecipient

Inherited Members

Entity.GetReadOnly()

Entity.CompareTo(object)

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.ToString()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Recipient()

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

public Recipient()

Recipient(Id?)

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

public Recipient(Id? id)

Parameters

id Id

The Id.

Recipient(Id?, User?, string?, RecipientType?, NotificationBinaryFile?, Group?, TripType?, DataModeType?)

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

public Recipient(Id? id, User? user, string? email, RecipientType? recipientType, NotificationBinaryFile? notificationBinaryFile, Group? group, TripType? tripType = null, DataModeType? dataModeType = null)

Parameters

id Id

The Id.

user User

The User this recipient points to, can be null.

email string

The email address this recipient refers too - can be empty.

recipientType RecipientType?

The RecipientType - this indicates the Notification mechanism.

notificationBinaryFile NotificationBinaryFile

The NotificationBinaryFile, can be null.

group Group

The Group to add device to, can be null.

tripType TripType?

The TripType this recipient refers too - can be empty.

dataModeType DataModeType

The DataModeType this recipient refers too - can be empty.

Recipient(Recipient)

Initializes a new instance of the Recipient class. Copy constructor - Initializes a new instance of the Recipient class.

public Recipient(Recipient recipient)

Parameters

recipient Recipient

The Recipient.

Properties

Address

Gets or sets the email address used when sending notifications via Email.

public virtual string? Address { get; set; }

Property Value

string

string

DataModeType

Gets or sets the DataModeType to assign the related device to.

public DataModeType? DataModeType { get; set; }

Property Value

DataModeType

DataModeType

Group

Gets or sets the Group to assign the related device to.

public Group? Group { get; set; }

Property Value

Group

Group

NotificationBinaryFile

Gets or sets the NotificationBinaryFile to notify with.

public NotificationBinaryFile? NotificationBinaryFile { get; set; }

Property Value

NotificationBinaryFile

NotificationBinaryFile

RecipientType

Gets or sets the RecipientType (type of notification message) this instance refers to.

public virtual RecipientType? RecipientType { get; set; }

Property Value

RecipientType?

RecipientType

TripType

Gets or sets the TripType to assign the related device to.

public TripType? TripType { get; set; }

Property Value

TripType?

TripType

User

Gets or sets the User to receive notification.

public virtual User? User { get; set; }

Property Value

User

User

Methods

Clone()

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

public override IEntity Clone()

Returns

IEntity

A copy of the current instance.

SystemFromId(Id?)

Returns a system User from the provided system Id else null if its a not a system user.

public static Recipient? SystemFromId(Id? id)

Parameters

id Id

The Id.

Returns

Recipient

The recipient.