Class MessagesReceivedManagement

Namespace

Iot.Device.Swarm

Assembly

Iot.Device.Swarm.dll

Class with API to manage received messages in the device database.

public class MessagesReceivedManagement

Inheritance

object

MessagesReceivedManagement

Properties

Count

Count of received messages available in the device database.

public int Count { get; }

Property Value

int

UnreadCount

Count of received messages unread available in the device database.

public int UnreadCount { get; }

Property Value

int

Methods

DeleteAllMessages()

Deletes all the received messages from the device database.

public bool DeleteAllMessages()

Returns

bool

true on successful deletion of the messages.

DeleteAllReadMessages()

Deletes all the received messages marked as read from the device database.

public bool DeleteAllReadMessages()

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.

MarkAllMessagesRead()

Marks all the received messages as read.

public bool MarkAllMessagesRead()

Returns

bool

true on successful marking of the messages.

MarkMessageRead(string)

Marks the specified message as read.

public bool MarkMessageRead(string id)

Parameters

id string

ID of message.

Returns

bool

true on successful marking of the message.

ReadMessage(string)

Reads the specified message from the device database.

public MessageReceived ReadMessage(string id)

Parameters

id string

ID of message.

Returns

MessageReceived

The MessageReceived read.

Remarks

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

ReadNewestMessage()

Reads the newest message from the device database.

public MessageReceived ReadNewestMessage()

Returns

MessageReceived

The MessageReceived message read.

Remarks

This is will return null if there are no messages in the device database.

ReadOldestMessage()

Reads the oldest message from the device database.

public MessageReceived ReadOldestMessage()

Returns

MessageReceived

The MessageReceived message read.

Remarks

This is will return null if there are no messages in the device database.