Class DeviceStatusInfoSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for DeviceStatusInfo(s).

public class DeviceStatusInfoSearch : Search, IEntity

Inheritance

object

Search

DeviceStatusInfoSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DeviceStatusInfoSearch()

Initializes a new instance of the DeviceStatusInfoSearch class.

public DeviceStatusInfoSearch()

DeviceStatusInfoSearch(Device, IEnumerable<Diagnostic>?)

Initializes a new instance of the DeviceStatusInfoSearch class.

public DeviceStatusInfoSearch(Device device, IEnumerable<Diagnostic>? diagnostics = null)

Parameters

device Device

Device to search for.

diagnostics IEnumerable<Diagnostic>

Diagnostics to search for.

Properties

ClosestAssetLimit

Gets or sets the maximum number of Devices to search for when specifying a "Position".

public int? ClosestAssetLimit { get; set; }

Property Value

int?

int

DeviceSearch

Gets or sets search for DeviceStatusInfo(s) from a device that matches the DeviceSearch Id or in the Groups specified. This includes archived and deleted devices. Available DeviceSearch options are:.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

DeviceStatusFilterCondition

Gets or sets devices based on current status, IsDriving and IsDeviceCommunicating. And/Or filtering.

public DeviceStatusFilterCondition? DeviceStatusFilterCondition { get; set; }

Property Value

DeviceStatusFilterCondition

And/or relation between device status for search

Diagnostics

Gets or sets a list of diagnostics when looking for the latest values for those diagnostics. Available Diagnostics options are:.

public IEnumerable<Diagnostic>? Diagnostics { get; set; }

Property Value

IEnumerable<Diagnostic>

Diagnostic

ExcludeExceptionEvents

Gets or sets a value indicating whether to exclude exception events. Default [false].

public bool? ExcludeExceptionEvents { get; set; }

Property Value

bool?

bool

Id

Gets or sets DeviceStatusInfoId search criteria.

public override Id? Id { get; set; }

Property Value

Id

Id

IsDeviceCommunicating

Gets or sets search for devices based on their current communicating status. A device is communicating: - When the vehicle is driving and has communicated within the past 10 minutes. - When the vehicle is not driving and has communicated within the past 24 hours.

public bool? IsDeviceCommunicating { get; set; }

Property Value

bool?

true to only return communicating devices. false to only return not communicating devices.

IsDriving

Gets or sets a 'single' search filter for devices that are 'driving'. Cannot be driving if not communicating.

public bool? IsDriving { get; set; }

Property Value

bool?

true driving and communicating false not driving or Inactive

MaxId

Gets or sets the maximum Id of the search criteria.

public Id? MaxId { get; set; }

Property Value

Id

Id

MaxSearchRadius

Gets or sets the maximum search radius centre at Position when looking for nearest Devices in kilometers.

public float? MaxSearchRadius { get; set; }

Property Value

float?

float

Position

Gets or sets search for Status Info for Devices in the vicinity of the provided Coordinate. Starting from this position, an outward search for Devices will continue until the number of devices found matches the number defined in the "ClosestAssetLimit" property.

public Coordinate? Position { get; set; }

Property Value

Coordinate

Coordinate

UserSearch

Gets or sets search for Device Status Info associated with this UserSearch Id. Available UserSearch options are:.

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch