Class MessagesToTransmitManagement

Namespace

Iot.Device.Swarm

Assembly

Iot.Device.Swarm.dll

Class with API to manage the device database for the messages to be transmitted.

public class MessagesToTransmitManagement

Inheritance

object

MessagesToTransmitManagement

Properties

Count

Count of unsent messages available in the device database.

public int Count { get; }

Property Value

int

Methods

DeleteAllMessages()

Deletes all the unsent messages from the device database.

public bool DeleteAllMessages()

Returns

bool

true on successful deletion of the messages.

DeleteMessage(string)

Deletes the specified message from the device database.

public bool DeleteMessage(string id)

Parameters

id string

ID of message.

Returns

bool

true on successful deletion of the message.

GetAllMessages()

Gets all the unsent messages from the device database.

public MessageToTransmit[] GetAllMessages()

Returns

MessageToTransmit[]

A array with MessageReceived messages read.

Remarks

This is will return an empty array if there are no messages in the device database.

GetMessage(string)

Gets the specified message from the device database.

public MessageToTransmit GetMessage(string id)

Parameters

id string

ID of message.

Returns

MessageToTransmit

The MessageToTransmit read.

Remarks

This is will return null if there message doesn't exist in the device database.