Class DeviceRegistrationChecksumResult

Namespace

Geotab.Checkmate.ObjectModel.Registration.Gateway

Assembly

Geotab.Checkmate.ObjectModel.dll

Encapsulates a device registration checksum result via the Gateway.

public class DeviceRegistrationChecksumResult : RegistrationResult

Inheritance

object

GatewayServiceResult

RegistrationResult

DeviceRegistrationChecksumResult

Inherited Members

RegistrationResult.AttemptedJurisdiction

GatewayServiceResult.Exception

GatewayServiceResult.ExceptionType

GatewayServiceResult.ExceptionMessage

GatewayServiceResult.IsSuccess

GatewayServiceResult.AttemptedDateTime

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

The API will generate and throw exceptions. We will package them and add additional properties as applicable.

Constructors

DeviceRegistrationChecksumResult(Exception?, Jurisdiction?, DateTime?, (bool IsMatch, IEnumerable<int> HardwareIds))

Initializes a new instance of the DeviceRegistrationChecksumResult class.

public DeviceRegistrationChecksumResult(Exception? exception, Jurisdiction? attemptedJurisdiction, DateTime? attemptedDateTime, (bool IsMatch, IEnumerable<int> HardwareIds) checksumResult)

Parameters

exception Exception

The exception to encapsulate.

attemptedJurisdiction Jurisdiction?

The jurisdiction requested.

attemptedDateTime DateTime?

The attempted registration date/time.

checksumResult (bool IsMatch, IEnumerable<int> HardwareIds)

The device registration checksum result.

Properties

HardwareIds

Gets a value indicating the hardware ID's currently registered with the Gateway.

public IEnumerable<int> HardwareIds { get; }

Property Value

IEnumerable<int>

IEnumerable<T> The collection of registered device hardware ID's.

Remarks

This value will be populated if IsMatch is false.

IsKnownError

Gets a value indicating whether the error during the request is known.

public override bool? IsKnownError { get; }

Property Value

bool?

bool The boolean insdicating this is a known error, if an error is present.

IsMatch

Gets a value indicating whether the checksums matched.

public bool IsMatch { get; }

Property Value

bool

bool The boolean value indicating checksums have matched.