Table of Contents

Class Driver

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

A driver in the system, and it is derived from User, with key ids and driver groups. If the driver is unknown then the driver is represented by "UnknownDriver".

[ReportClass]
public class Driver : User, IEntity, IComparable, IIdentifiable, IVersion, IGroupLinked, IDefaultable, IMediaFiles, IInstanceSizeEstimate
Inheritance
Driver
Implements
Derived
Inherited Members
Extension Methods

Constructors

Driver()

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

public Driver()

Driver(Driver)

Initializes a new instance of the Driver class. Copy constructor - initializes a new instance of the Driver class.

protected Driver(Driver driver)

Parameters

driver Driver

The driver.

Driver(Id?)

Initializes a new instance of the Driver class.Constructor.

public Driver(Id? id)

Parameters

id Id

The Id.

Driver(Id?, long?, string?, string?, string?, string?, string?, UserAuthenticationType?, string?, string?, string?, DateTime?, DateTime?, IList<Group>?, IList<Group>?, IList<Group>?, IList<Group>?, ClientSettings?, Certificate?, IList<Group>?, List<Key>?, bool?, IList<MediaFile>?, GroupFilter?, IAMMetadata?)

Initializes a new instance of the Driver class.Initializes a new instance of the User class.

public Driver(Id? id, long? version, string? userId, string? email, string? firstName, string? lastName, string? password, UserAuthenticationType? loginType, string? comment, string? designation, string? employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group>? companyGroups, IList<Group>? reportGroups, IList<Group>? securityGroups, IList<Group>? privateUserGroups, ClientSettings? clientSettings, Certificate? issuerCertificate, IList<Group>? driverGroups, List<Key>? keys, bool? viewDriversOwnDataOnly, IList<MediaFile>? mediaFiles = null, GroupFilter? accessGroupFilter = null, IAMMetadata? iamMetadata = null)

Parameters

id Id

The Id.

version long?

The version.

userId string

The user ID.

email string

The user email.

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

loginType UserAuthenticationType?

The UserAuthenticationType.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The Date from when the User is valid.

activeTo DateTime?

The Date to when the User is valid.

companyGroups IList<Group>

Group collection this user belongs to.

reportGroups IList<Group>

Group collection this user belongs to with only report access.

securityGroups IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

privateUserGroups IList<Group>

The private user group collection which is specifically used for generate dashboard and email report for the user itself.

clientSettings ClientSettings

The ClientSettings for this User.

issuerCertificate Certificate

The issuer Certificate. Only needed for users not using basic authentication.

driverGroups IList<Group>

Home groups for the driver.

keys List<Key>

keys for the driver.

viewDriversOwnDataOnly bool?

if set to true [view driver's own trip only].

mediaFiles IList<MediaFile>

The list of MediaFile of MediaType Image for the display pictures of this driver

accessGroupFilter GroupFilter

User Group Filter

iamMetadata IAMMetadata

The IAMMetadata for the Driver

Driver(Id?, string?, string?, string?, string?, string?, UserAuthenticationType?, string?, string?, string?, DateTime?, DateTime?, IList<Group>?, IList<Group>?, IList<Group>?, IList<Group>?, ClientSettings?, Certificate?, IList<Group>?, List<Key>?, bool?, IList<MediaFile>?, GroupFilter?, IAMMetadata?)

Initializes a new instance of the Driver class.Initializes a new instance of the User class.

[Obsolete("Use constructor with version", false)]
public Driver(Id? id, string? userId, string? email, string? firstName, string? lastName, string? password, UserAuthenticationType? loginType, string? comment, string? designation, string? employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group>? companyGroups, IList<Group>? reportGroups, IList<Group>? securityGroups, IList<Group>? privateUserGroups, ClientSettings? clientSettings, Certificate? issuerCertificate, IList<Group>? driverGroups, List<Key>? keys, bool? viewDriversOwnDataOnly, IList<MediaFile>? mediaFiles = null, GroupFilter? accessGroupFilter = null, IAMMetadata? iamMetadata = null)

Parameters

id Id

The Id.

userId string

The user ID.

email string

The user email.

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

loginType UserAuthenticationType?

The UserAuthenticationType.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The Date from when the User is valid.

activeTo DateTime?

The Date to when the User is valid.

companyGroups IList<Group>

Group collection this user belongs to.

reportGroups IList<Group>

Group collection this user belongs to with only report access.

securityGroups IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

privateUserGroups IList<Group>

The private user group collection which is specifically used for generate dashboard and email report for the user itself.

clientSettings ClientSettings

The ClientSettings for this User.

issuerCertificate Certificate

The issuer Certificate. Only needed for users not using basic authentication.

driverGroups IList<Group>

Home groups for the driver.

keys List<Key>

keys for the driver.

viewDriversOwnDataOnly bool?

if set to true [view driver's own trip only].

mediaFiles IList<MediaFile>

The list of MediaFile of MediaType Image for the display pictures of this driver

accessGroupFilter GroupFilter

User Group Filter

iamMetadata IAMMetadata

The IAMMetadata for the Driver

Properties

DriverGroups

Gets or sets the home Group(s) for the driver.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DriverGroup }, IsList = true)]
public virtual IList<Group>? DriverGroups { get; set; }

Property Value

IList<Group>

IList<T>

Keys

Gets or sets the NFC Key's serial number associated with the driver.

public List<Key>? Keys { get; set; }

Property Value

List<Key>

IList<T>

LicenseNumber

Gets or sets the driver license number of the user. Default [""].

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

Property Value

string

LicenseNumber

LicenseProvince

Gets or sets the driver license province or state of the user. Default [""].

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

Property Value

string

LicenseProvince

ViewDriversOwnDataOnly

Gets or sets a value indicating whether the driver can view their own data.

public bool? ViewDriversOwnDataOnly { get; set; }

Property Value

bool?

bool

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.

DriverKeysContainSameKeyType()

Returns a boolean representing if a User have more then one same key type.

public bool DriverKeysContainSameKeyType()

Returns

bool

The bool.

DriverSystemFromId(Id?)

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

public static Driver? DriverSystemFromId(Id? id)

Parameters

id Id

The id.

Returns

Driver

The Driver.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public override void PopulateDefaults()