Class DeviceShareSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

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

public class DeviceShareSearch : Search, IEntity

Inheritance

object

Search

DeviceShareSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

Search.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DeviceShareSearch()

Initializes a new instance of the DeviceShareSearch class.

public DeviceShareSearch()

DeviceShareSearch(Id)

Initializes a new instance of the DeviceShareSearch class.

public DeviceShareSearch(Id id)

Parameters

id Id

The identifier.

Properties

AcceptedDateTime

Gets or sets search for DeviceShares accepted from this date onwards.

public DateTime? AcceptedDateTime { get; set; }

Property Value

DateTime?

DateTime

DateTime

Gets or sets search for DeviceShares created from this date onwards.

public DateTime? DateTime { get; set; }

Property Value

DateTime?

DateTime

DevicePlan

Gets or sets search for DeviceShares using DevicePlan.

public DevicePlan? DevicePlan { get; set; }

Property Value

DevicePlan?

DevicePlan

DevicePlanBillingInfo

Gets or sets search for a DeviceShare using billing level in DevicePlanBillingInfo. Available DevicePlanBillingInfo search options are:

public DevicePlanBillingInfo? DevicePlanBillingInfo { get; set; }

Property Value

DevicePlanBillingInfo

DevicePlanBillingInfo

ExclusiveDates

Gets or sets the ExclusiveDateSearch flag. Set to true to search for dates exclusively (meaning greater/less than is used instead greater/less or equal to when filtering results).

public bool? ExclusiveDates { get; set; }

Property Value

bool?

bool

FindFirstAfterDate

Gets or sets the FindFirstAfterDate flag. Set to true to find the first device share after the only non-null date field. Setting more than one date field will cause an exception. Also, this option cannot be used in combination with the FindFirstBeforeDate.

public bool? FindFirstAfterDate { get; set; }

Property Value

bool?

bool

FindFirstBeforeDate

Gets or sets the GetFirstBeforeDate flag. Set to true to find the first device share before the only non-null date field. Setting more than one date field will cause an exception. Also, this option cannot be used in combination with the FindFirstAfterDate

public bool? FindFirstBeforeDate { get; set; }

Property Value

bool?

bool

FindFromDevices

Gets or sets search for device shares belonging to devices (using their serial number).Note, if this field is set, no other search field is considered.

public IList<Device>? FindFromDevices { get; set; }

Property Value

IList<Device>

Tuple

FindFromMyAdminIds

Gets or sets search for device shares using a list MyAdmin ids.

public IList<int>? FindFromMyAdminIds { get; set; }

Property Value

IList<int>

IList{int}

FindFromSerialNumbers

Gets or sets search for device shares using device serial numbers. Note, if this field is set, no other search field is considered.

public IList<string>? FindFromSerialNumbers { get; set; }

Property Value

IList<string>

IList<T>

FindPendingOrActiveOnly

Gets or sets the FindPendingOrActiveOnly flag. Set to true to find only device shares that have a share status of either pending or active.

public bool? FindPendingOrActiveOnly { get; set; }

Property Value

bool?

bool

MyAdminId

Gets or sets search for a DeviceShare using its MyAdmin id.

public int? MyAdminId { get; set; }

Property Value

int?

int

SerialNumber

Gets or sets search for a DeviceShares having a given serial number.

public string? SerialNumber { get; set; }

Property Value

string

string

ShareStatus

Gets or sets search for DeviceShares using DeviceShareStatus.

public DeviceShareStatus? ShareStatus { get; set; }

Property Value

DeviceShareStatus?

string

ShareType

Gets or sets search for DeviceShares using DeviceShareType.

public DeviceShareType? ShareType { get; set; }

Property Value

DeviceShareType?

string

SourceDatabaseName

Gets or sets search for DeviceShares using SourceDatabaseName matching this value. Wildcard can be used by prepending/appending "%" to string. Example "%database%".

public string? SourceDatabaseName { get; set; }

Property Value

string

string

TargetDatabaseName

Gets or sets search for DeviceShares using TargetDatabaseName matching this value. Wildcard can be used by prepending/appending "%" to string. Example "%database%".

public string? TargetDatabaseName { get; set; }

Property Value

string

string

TerminatedDateTime

Gets or sets search for DeviceShares terminated from this date onwards.

public DateTime? TerminatedDateTime { get; set; }

Property Value

DateTime?

DateTime

ToDate

Gets or sets the max date that a date field will be bound by. Only one other date field can be used in combination with the ToDate. If this is the only date field set, then the results will be bound by the DateTime field.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

UpdatedDateTime

Gets or sets search for DeviceShares updated from this date onwards.

public DateTime? UpdatedDateTime { get; set; }

Property Value

DateTime?

DateTime