Table of Contents

Class UserSystem

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

Base class for all system user types.

public abstract class UserSystem : User, IEntity, IComparable, IIdentifiable, IVersion, IGroupLinked, IDefaultable, IMediaFiles, IInstanceSizeEstimate
Inheritance
UserSystem
Implements
Derived
Inherited Members
Extension Methods

Constructors

UserSystem(Id, long?, string?, string?, UserAuthenticationType?, IList<Group>?, IList<Group>?, IList<Group>?, IList<Group>?)

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

protected UserSystem(Id id, long? version, string? userId, string? name, UserAuthenticationType? loginType, IList<Group>? companyGroups, IList<Group>? reportGroups, IList<Group>? securityGroups, IList<Group>? privateGroups)

Parameters

id Id

The id.

version long?

The version.

userId string

The user id.

name string

The name.

loginType UserAuthenticationType?

The UserAuthenticationType.

companyGroups IList<Group>

The company groups.

reportGroups IList<Group>

The report groups.

securityGroups IList<Group>

The security groups.

privateGroups IList<Group>

The private groups.

UserSystem(User)

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

protected UserSystem(User user)

Parameters

user User

The user.

Properties

CompanyGroups

Gets or sets the list of organization Group(s) that the user belongs to.

public override IList<Group>? CompanyGroups { get; set; }

Property Value

IList<Group>

Group The list of company group.

Id

Gets or sets the unique identifier for this entity. see Id.

public override Id? Id { get; set; }

Property Value

Id

The Id .

Name

Gets or sets the name of this entity which identifies it and is used when displaying this entity. The name cannot be changed for this user.

public override string? Name { get; set; }

Property Value

string

The name.

PrivateUserGroups

Gets or sets the private Group(s) that the user belongs to.

public override IList<Group>? PrivateUserGroups { get; set; }

Property Value

IList<Group>

Group The list of private user groups.

ReportGroups

Gets or sets the Group(s) for reporting that this user belongs to.

public override IList<Group>? ReportGroups { get; set; }

Property Value

IList<Group>

Group The list of reporting groups.

SecurityGroups

Gets or sets the security Group(s) this user belongs to defining the users access.

public override IList<Group>? SecurityGroups { get; set; }

Property Value

IList<Group>

Group The list of security groups.

Version

Gets or sets the version of the entity.

public override long? Version { get; set; }

Property Value

long?

The long version.

Methods

IsSystemEntity()

Returns true if the class is a system entity, false otherwise.

public override bool IsSystemEntity()

Returns

bool

true if the entity is a system entity; otherwise, false.