Class CommunicationLog

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

Log of communication attempts made.

public sealed class CommunicationLog : Entity, IEntity, IComparable, IIdentifiable, IDateTimeProvider

Inheritance

object

Entity

CommunicationLog

Implements

IEntity

IComparable

IIdentifiable

IDateTimeProvider

Inherited Members

Entity.GetReadOnly()

Entity.CompareTo(object)

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.ToString()

Entity.Id

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CommunicationLog(Id?, string, string, IEntity, DateTime?, bool?)

Initializes a new instance of the CommunicationLog class.

public CommunicationLog(Id? id, string communicationType, string objectId, IEntity messageInfo, DateTime? dateTime, bool? successful)

Parameters

id Id

The Id of the log.

communicationType string

The communication log type (the operation performed and logged).

objectId string

The key to identify the object being logged.

messageInfo IEntity

The IEntity being logged.

dateTime DateTime?

The DateTime the log was created.

successful bool?

The flag indicating if the communication was successful or not.

Properties

CommunicationType

Gets or sets the communication type identifier.

public string CommunicationType { get; set; }

Property Value

string

string

DateTime

Gets the date.

public DateTime? DateTime { get; set; }

Property Value

DateTime?

DateTime

MessageInfo

Gets or sets the object with all the necessary information needed to re-attempt the communication.

public IEntity MessageInfo { get; set; }

Property Value

IEntity

IEntity

ObjectId

Gets or sets the property name of the object to be used as id of the object being logged.

public string ObjectId { get; set; }

Property Value

string

string

Successful

Gets or sets a value indicating whether the date and time when the communication was attempt.

public bool? Successful { get; set; }

Property Value

bool?

bool

Methods

Clone()

All objects in database of the Geotab System are an entity. These have a unique identifier Id that can be used later to Get, modify (Set) or Remove that object.

public override IEntity Clone()

Returns

IEntity

DeserializeEntity(object)

Deserialize the message text into a IEntity.

public static IEntity? DeserializeEntity(object entityContent)

Parameters

entityContent object

The entityContent.

Returns

IEntity

An IEntity.

SerializeEntity(IEntity)

Deserialize the message text into a IEntity.

public static string SerializeEntity(IEntity entityContent)

Parameters

entityContent IEntity

The entityContent.

Returns

string

An IEntity.

ValidateLog()

Validates if the required properties are set.

public void ValidateLog()

Exceptions

ArgumentNullException

Exception returned when a property is missing its value.