mCore™ .NET SMS Library 1.2

Inbox.Refresh Method

Description:

The Inbox.Refresh method reads messages from the message memory as defined in mCore.SMS.MessageMemory property. Returns a Boolean value True if there are no errors in reading messages.

Namespace: mCore
Assembly: mCoreLib (in mCoreLib.dll)

Overload List:

Name Description
Refresh () Reads all the messages in the message memory defined by the mCore.SMS.MessageMemory property.
Refresh (ReadMessageType As mCore.MessageType) Reads only unread messages, read messages or both types as defined by ReadMessageType parameter.
Refresh (ReadMessageType As mCore.MessageType, CleanUpMemory As Boolean) Reads only unread messages, read messages or both types as defined by ReadMessageType parameter, and cleans up the message memory if CleanUpMemory set as True (i.e. deletes all smart messages like ringtone, wap push etc in message memory)

Exceptions:

mCore.SMSReadException
mCore.GeneralException

Usage Example:

Visual Basic

Public Class MyClass
   Public WithEvents objSMS As New mCore.SMS
   Public Sub ReadInbox()
      Dim Msg As mCore.Message
      Try
         SetCommParameters()
         objSMS.MessageMemory = mCore.MessageMemory.ME
         Try
            objSMS.Inbox.Refresh()

         Catch ex As mCore.SMSReadException
            MsgBox("Error reading Inbox!" & vbCrLf & ex.Message)
         End Try

         If objSMS.Inbox.HasMessages Then
            MsgBox("Total " & objSMS.Inbox.Count.ToString() & " messages")
            For Each Msg In objSMS.Inbox
               MsgBox("From:" & Msg.Phone & vbCrLf & Msg.Text)
            Next
            Try
               objSMS.Inbox.Clear()
            Catch ex As mCore.SMSDeleteException
               MsgBox(ex.Message, MsgBoxStyle.Critical, "mCore Demo")
            End Try
         End If
      Catch ex As mCore.GeneralException
         MsgBox(ex.Message, MsgBoxStyle.Critical, "mCore Demo")
      Catch ex As Exception
      End Try
   End Sub

   Public Sub SetCommParameters()
      Try
         objSMS.Port = "COM1"
         objSMS.BaudRate = mCore.BaudRate.BaudRate_19200
         objSMS.DataBits = mCore.DataBits.Eight
         objSMS.StopBits = mCore.StopBits.One
         objSMS.Parity = mCore.Parity.None
         objSMS.FlowControl = mCore.FlowControl.RTS_CTS

      Catch ex As mCore.GeneralException
         MsgBox(ex.Message)
      Catch ex As Exception
      End Try
   End Function
End Class

 
C#
class MyClass
{
   public mCore.SMS objSMS = new mCore.SMS();
   public static void ReadInbox()
   {
      mCore.Message Msg;
      try
      {

         SetCommParameters();
         objSMS.MessageMemory = mCore.MessageMemory.ME;
         try
         {
            objSMS.Inbox().Refresh();
         }
         catch (mCore.SMSReadException ex)
         {
            MessageBox.Show("Error reading Inbox!" + "\r\n" + ex.ToString());;
         }
         if (objSMS.Inbox().HasMessages)
         {
            MessageBox.Show("Total " + objSMS.Inbox().Count.ToString() + " messages");
            foreach (mCore.Message Msg in objSMS.Inbox())
            {
               MessageBox.Show("From: " + Msg.Phone + "\r\n" + Msg.Text);
            }
            try
            {
               objSMS.Inbox().Clear();
            }
            catch (mCore.SMSDeleteException e)
            {
               MessageBox.Show(e.ToString());
            }
         }
      }

      catch (mCore.GeneralException e)
      {
         MessageBox.Show(e.ToString());
      }
      catch (Exception e)
      {
      }
   }

   public static void SetCommParameters()
   {
      try
      {
         objSMS.Port = "COM1";
         objSMS.BaudRate = mCore.BaudRate.BaudRate_19200;
         objSMS.DataBits = mCore.DataBits.Eight;
         objSMS.StopBits = mCore.StopBits.One;
         objSMS.Parity = mCore.Parity.None;
         objSMS.FlowControl = mCore.FlowControl.RTS_CTS;
      }

      catch (mCore.GeneralException e)
      {
         MessageBox.Show(e.ToString());
      }
      catch (Exception e)
      {
      }
   }
}

See Also:

mCore.Inbox Class
mCore.Message Class
mCore.SMS.Inbox Method
Inbox.Message Method
Inbox.Concatenate Property
mCore.SMSReadException Class

 

Copyright © IG Logix Softech Pvt Ltd, All Rights Reserved