Class UserModifiedValueInfo

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A class which represents data associated with NotificationUserModifiedData. This type holds additional information about properties of the User which were modified. It only applies to certain types of UserModification (see AreValuesRequired(UserModification?)).

public class UserModifiedValueInfo : UserModifiedInfo, IEquatable<UserModifiedInfo>, IEqualityComparer<UserModifiedValueInfo>

Inheritance

object

UserModifiedInfo

UserModifiedValueInfo

Implements

IEquatable<UserModifiedInfo>

IEqualityComparer<UserModifiedValueInfo>

Inherited Members

UserModifiedInfo.Equals(UserModifiedInfo)

UserModifiedInfo.ModifiedUserName

UserModifiedInfo.ModifiedByUserName

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

UserModifiedValueInfo(string, string, IEnumerable<string>?, IEnumerable<string>?, string?, bool)

Initializes a new instance of the UserModifiedValueInfo class.

public UserModifiedValueInfo(string modifiedUser, string modifiedByUser, IEnumerable<string>? valuesAdded, IEnumerable<string>? valuesRemoved, string? message = null, bool isUserLockedOut = false)

Parameters

modifiedUser string

The Name of the User who was modified.

modifiedByUser string

The Name of the administrator User who changed modifiedUser.

valuesAdded IEnumerable<string>

The set of property values that were added to modifiedUser.

valuesRemoved IEnumerable<string>

The set of property values that were removed from modifiedUser.

message string

The message from the Audit.

isUserLockedOut bool

The is user locked out flag.

Exceptions

ArgumentNullException

Thrown if both modifiedUser and modifiedByUser are null or empty.

Properties

IsUserLockedOut

Gets or sets a value indicating whether the notification is a user locked out notification.

public bool IsUserLockedOut { get; set; }

Property Value

bool

Returns whether the user is locked out

Message

Gets a string representing the value that was sent to the Audit log from given property Comment

public string Message { get; }

Property Value

string

A string representing the value that was sent to the Audit log from given property Comment

PropertyValuesAdded

Gets a set of strings representing values that were added to a property for a given User. Only applicable for ClearancesChanged or GroupsChanged. When a User's Groups are modified, the names of all the groups that were added. OR: When a User's SecurityClearances are modified, the names of all the clearances that were added.

public IEnumerable<string>? PropertyValuesAdded { get; }

Property Value

IEnumerable<string>

A set of strings representing values that were added to a property for a given User. Only applicable for ClearancesChanged or GroupsChanged. When a User's Groups are modified, the names of all the groups that were added. OR: When a User's SecurityClearances are modified, the names of all the clearances that were added.

PropertyValuesRemoved

Gets a set of strings representing values that were removed from a property for a given User. Only applicable for ClearancesChanged or GroupsChanged. When a User's Groups are modified, the names of all the groups that were removed. OR: When a User's SecurityClearances are modified, the names of all the clearances that were removed.

public IEnumerable<string>? PropertyValuesRemoved { get; }

Property Value

IEnumerable<string>

A set of strings representing values that were removed from a property for a given User. Only applicable for ClearancesChanged or GroupsChanged. When a User's Groups are modified, the names of all the groups that were removed. OR: When a User's SecurityClearances are modified, the names of all the clearances that were removed.

Methods

AreValuesRequired(UserModification?)

Determines whether or not a UserModification value requires UserModifiedValueInfo rather than UserModifiedInfo. Some types of UserModification require additional info to be attached with NotificationUserModifiedData.

public static bool AreValuesRequired(UserModification? modificationType)

Parameters

modificationType UserModification?

The enum value of UserModification to check if additional values are required.

Returns

bool

true if modificationType requires UserModifiedValueInfo.

Equals(UserModifiedValueInfo?, UserModifiedValueInfo?)

public bool Equals(UserModifiedValueInfo? x, UserModifiedValueInfo? y)

Parameters

x UserModifiedValueInfo

y UserModifiedValueInfo

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetHashCode(UserModifiedValueInfo)

public int GetHashCode(UserModifiedValueInfo obj)

Parameters

obj UserModifiedValueInfo

Returns

int