Class Key

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

Represent the key used to identify a Driver.

[ReportClass]
public class Key : Entity, IEntity, IComparable, IIdentifiable, IDriverProvider

Inheritance

object

Entity

Key

Implements

IEntity

IComparable

IIdentifiable

IDriverProvider

Derived

CustomKey

CustomNfcKey

NfcKey

TachographKey

UsbKey

Inherited Members

Entity.GetReadOnly()

Entity.CompareTo(object)

Entity.IsSystemEntity()

Entity.ToString()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Key()

Initializes a new instance of the Key class. Default constructor.

public Key()

Key(DriverKeyType?, long?, string?)

Initializes a new instance of the Key class. The constructor.

public Key(DriverKeyType? driverKeyType, long? keyId, string? serialNumber)

Parameters

driverKeyType DriverKeyType?

The DriverKeyType of the key.

keyId long?

The key Id.

serialNumber string

The serial Number.

Properties

Driver

Gets or sets driver of the driver key.

public Driver? Driver { get; set; }

Property Value

Driver

Driver

DriverKeyType

Gets or sets the DriverKeyType.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DriverkeyType })]
public DriverKeyType? DriverKeyType { get; set; }

Property Value

DriverKeyType?

DriverKeyType

KeyId

Gets or sets the ID of the driver key. Represents the decoded serial number. USB blue keys are assigned a key ID.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DriverKeyId })]
public long? KeyId { get; set; }

Property Value

long?

long

SerialNumber

Gets or sets the Serial Number of the driver key. Represents the key ID encoded as a serial number. NFC keys are assigned a serial number.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DriverKeySerialNumber })]
public string? SerialNumber { get; set; }

Property Value

string

string

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.

Equals(object?)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.