Class TextMessageSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for a TextMessage.

public class TextMessageSearch : Search, IEntity

Inheritance

object

Search

TextMessageSearch

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

TextMessageSearch()

Initializes a new instance of the TextMessageSearch class.

public TextMessageSearch()

TextMessageSearch(Id)

Initializes a new instance of the TextMessageSearch class.

public TextMessageSearch(Id id)

Parameters

id Id

The Id.

TextMessageSearch(DateTime?)

Initializes a new instance of the TextMessageSearch class.

public TextMessageSearch(DateTime? modifiedSinceDate)

Parameters

modifiedSinceDate DateTime?

The modified since date.

Properties

ChannelNumbers

Gets or sets search for TextMessages filtered based on channel numbers assigned. MessageContentTypes that support setting the channelNumber:

public IEnumerable<int>? ChannelNumbers { get; set; }

Property Value

IEnumerable<int>

List<T>

ContentTypes

Gets or sets search for TextMessages filtered based on the MessageContentType.

public IEnumerable<MessageContentType>? ContentTypes { get; set; }

Property Value

IEnumerable<MessageContentType>

MessageContentType

DeviceSearch

Gets or sets filter by the DeviceSearch options. Providing a device ID will search for any TextMessages that are assigned to that Device. Providing the Groups will search for TextMessages for that have Devices in that group. Available DeviceSearch options are:

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

FromDate

Gets or sets search for TextMessages that were sent at this date or after.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

Groups

Gets or sets search for TextMessages sent to Devices, Users or Recipients that are members of these GroupSearch(s) or their child Groups. Available GroupSearch options are:

public List<GroupSearch>? Groups { get; set; }

Property Value

List<GroupSearch>

IList<T>

Remarks

Repurposed in 7.0 to allow searching for text messages of any entity type belonging to these groups.

IsDelivered

Gets or sets search for delivered or undelivered TextMessages. If it's set to true, it will return all TextMessages that were delivered. If it set to false, it will return all TextMessages that were not delivered. If it is set to null, it will return both delivered and undelivered TextMessages.

public bool? IsDelivered { get; set; }

Property Value

bool?

bool

IsDirectionToVehicle

Gets or sets search for TextMessages based on the "direction" of the message. If it's set to true, it will return all TextMessages that were sent to a Device. If it set to false, it will return all TextMessages that were not sent to a Device. If it is set to null, it will return TextMessages sent to or from any asset type.

public bool? IsDirectionToVehicle { get; set; }

Property Value

bool?

bool

IsRead

Gets or sets search for read or unread TextMessages. If it's set to true, it will return all TextMessages that were read. If it set to false, it will return all TextMessages that were not unread. If it is set to null, it will return both read and unread TextMessages.

public bool? IsRead { get; set; }

Property Value

bool?

bool

LatestMessageOnly

Gets or sets a value indicating whether when LatestMessageOnly is set to True; only a single most recent message that matches the search parameters will be returned per device (using the date sent time to determine most recent).

public bool? LatestMessageOnly { get; set; }

Property Value

bool?

bool

MimeTypes

Gets or sets search for TextMessages filtered based on the messages MIME type. MimeTypes search is available for MimeContent only.

public IEnumerable<string>? MimeTypes { get; set; }

Property Value

IEnumerable<string>

List<T>

ModifiedSinceDate

Gets or sets search for TextMessages that were delivered/sent/read since this date.

public DateTime? ModifiedSinceDate { get; set; }

Property Value

DateTime?

DateTime

Notification

Gets or sets search for TextMessages that have Notification in messageContent.

public Notification? Notification { get; set; }

Property Value

Notification

The Id of the notification that created the message.

OnlyActiveMessages

Gets or sets a value indicating whether only TextMessages with ActiveTo > UtcNow are included.

public bool? OnlyActiveMessages { get; set; }

Property Value

bool?

bool

ParentMessageId

Gets or sets search for TextMessages that have parent id as this Id.

public Id? ParentMessageId { get; set; }

Property Value

Id

Id

ParentTextMessageId

Gets or sets search for TextMessages that have parent id as this id.

[Obsolete("Use ParentMessageId", false)]
public long? ParentTextMessageId { get; set; }

Property Value

long?

long

Remarks

ParentTextMessageId is obsolete and will be removed. Please use ParentMessageId search property.

RecipientSearch

Gets or sets search for TextMessages sent to this UserSearch. Available UserSearch options are:

public UserSearch? RecipientSearch { get; set; }

Property Value

UserSearch

UserSearch

ToDate

Gets or sets search for TextMessages that were sent at this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

UserSearch

Gets or sets search for TextMessages sent by this UserSearch. Available UserSearch options are:

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch