Interface IGatewayInvoker

Namespace

Geotab.Checkmate.Web

Assembly

Geotab.Checkmate.ObjectModel.dll

An interface defining the requirements for a Gateway invoker.

public interface IGatewayInvoker : IWebServerInvoker

Inherited Members

IWebServerInvoker.InvokeAsync<T>(string, object, CancellationToken)

IWebServerInvoker.InvokeAsync<T>(string, string, object, CancellationToken)

Methods

NotifyJurisdictionChangedAsync(Jurisdiction?, Guid?, CancellationToken)

Primary method to notify the Gateway that the MyGeotab jurisdiction has changed.

Task NotifyJurisdictionChangedAsync(Jurisdiction? jurisdiction, Guid? clientGuid, CancellationToken cancellationToken = default)

Parameters

jurisdiction Jurisdiction?

The jurisdiction.

clientGuid Guid?

The company ID.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

An object representing the notification result.

RegisterClientAsync(Guid?, string?, Jurisdiction?, CancellationToken)

Wrapped Gateway client registration call. This will replace use of current SetorAddClientJurisdiction API call.

Task<RegisterClientResponse> RegisterClientAsync(Guid? clientGuid, string? databaseName, Jurisdiction? jurisdiction, CancellationToken cancellationToken = default)

Parameters

clientGuid Guid?

The company ID.

databaseName string

The database name.

jurisdiction Jurisdiction?

The jurisdiction.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<RegisterClientResponse>

An awaitable task indicating the result of type RegisterClientResponse.

RegisterDeviceAsync(Jurisdiction?, int?, Guid?, string, CancellationToken)

Primary method to register a device via the Gateway.

Task RegisterDeviceAsync(Jurisdiction? jurisdiction, int? hardwareId, Guid? clientGuid, string reason, CancellationToken cancellationToken = default)

Parameters

jurisdiction Jurisdiction?

The jurisdiction.

hardwareId int?

The hardware ID.

clientGuid Guid?

The company ID.

reason string

The reason the device is being registered.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

An awaitable task.

SendDeviceRegistrationChecksumAsync(Jurisdiction?, Guid?, string?, CancellationToken)

Primary method to send the device registration states reconciliation checksum.

Task<(bool IsMatch, IEnumerable<int> HardwareIds)> SendDeviceRegistrationChecksumAsync(Jurisdiction? jurisdiction, Guid? clientGuid, string? checksum, CancellationToken cancellationToken = default)

Parameters

jurisdiction Jurisdiction?

The jurisdiction.

clientGuid Guid?

The company ID.

checksum string

The checksum.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<(bool IsMatch, IEnumerable<int> HardwareIds)>

An awaitable task.

SetOrAddClientJurisdictionAsync(Jurisdiction?, Guid?, CancellationToken)

Primary method to notify the Gateway of the MyGeotab client jurisdiction. This is called upon Database initialization.

Task<SetOrAddClientJurisdictionResponse> SetOrAddClientJurisdictionAsync(Jurisdiction? jurisdiction, Guid? clientGuid, CancellationToken cancellationToken = default)

Parameters

jurisdiction Jurisdiction?

The jurisdiction.

clientGuid Guid?

The company ID.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<SetOrAddClientJurisdictionResponse>

An awaitable task indicating the result of type SetOrAddClientJurisdictionResponse.

StoreCertificateAsync(string, int)

Primary method to store a device certificate in the Gateway.

Task StoreCertificateAsync(string certificate, int hardwareId)

Parameters

certificate string

The certificate.

hardwareId int

The hardware ID.

Returns

Task

An awaitable task indicating the result of the invocation.

UnregisterClientAsync(Guid?, string, CancellationToken)

Primary method to unregister a client via the Gateway.

Task UnregisterClientAsync(Guid? clientGuid, string reason, CancellationToken cancellationToken = default)

Parameters

clientGuid Guid?

The company ID.

reason string

The reason the client is being unregistered.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

An awaitable task.

UnregisterDeviceAsync(int?, Guid?, string, CancellationToken)

Primary method to unregister a device via the Gateway.

Task UnregisterDeviceAsync(int? hardwareId, Guid? clientGuid, string reason, CancellationToken cancellationToken = default)

Parameters

hardwareId int?

The hardware ID.

clientGuid Guid?

The company ID.

reason string

The reason the device is being unregistered.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

An awaitable task.