Class Credentials

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The authentication credentials for a User used when making calls to MyGeotab.

public class Credentials : ICredentials

Inheritance

object

Credentials

Implements

ICredentials

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Credentials()

Initializes a new instance of the Credentials class.

public Credentials()

Credentials(string?, string?, string?, string?, string?)

Initializes a new instance of the Credentials class.

public Credentials(string? database, string? username, string? password, string? sessionId, string? refreshToken = null)

Parameters

database string

users database.

username string

user name.

password string

user password.

sessionId string

session id.

refreshToken string

refresh token.

Fields

ThisServer

The ThisServer constant meaning that the credentials aren't on another server.

public const string ThisServer = "ThisServer"

Field Value

string

Properties

Database

Gets or sets the database name.

public string? Database { get; set; }

Property Value

string

the database name. string

Password

Gets or sets the users login password. This can be used instead of providing a session Id. It is mutually exclusive with SessionId.

public string? Password { get; set; }

Property Value

string

string

RefreshToken

Gets or sets the refresh token.

public string? RefreshToken { get; set; }

Property Value

string

string

SessionId

Gets or sets the session Id is a token which is generated from an authentication call and can be used instead of providing the password each time. It is mutually exclusive with Password.

public string? SessionId { get; set; }

Property Value

string

string

UserName

Gets or sets the MyGeotab username.

public string? UserName { get; set; }

Property Value

string

string

Methods

CreateDatabaseNameFromCompany(string)

Creates the database name from supplied company. Honours certain rules about naming databases.

public static string CreateDatabaseNameFromCompany(string companyName)

Parameters

companyName string

Name of the company.

Returns

string

Sanitized company name.

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string