Class SmsProvider
SMS client class with methods to send and read SMSs.
Inheritance
Implements
Inherited Members
Namespace: Eclo.nF.SIM800H
Assembly: cs.temp.dll.dll
Syntax
public class SmsProvider : IDisposable
Methods
DeleteTextMessage(Int32)
Delete a text message
Declaration
public AtCommandResult DeleteTextMessage(int position)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | position | Position in memory where the message is stored |
Returns
Type | Description |
---|---|
AtCommandResult |
DeleteTextMessages(MessageDeleteOption)
Deletes text messages according to delete option
Declaration
public AtCommandResult DeleteTextMessages(MessageDeleteOption deleteOption)
Parameters
Type | Name | Description |
---|---|---|
MessageDeleteOption | deleteOption | option to delete messages that match a criteria or are at specific storage |
Returns
Type | Description |
---|---|
AtCommandResult |
Dispose()
Declaration
public void Dispose()
Dispose(Boolean)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
Finalize()
Declaration
protected void Finalize()
ListTextMessagesAsync(MessageState, AsyncCallback, Object)
Starts an asynchronous operation to get a list with indexes of text messages that match the MessageState criteria
Declaration
public ListTextMessagesAsyncResult ListTextMessagesAsync(MessageState state, AsyncCallback asyncCallback = null, object asyncState = null)
Parameters
Type | Name | Description |
---|---|---|
MessageState | state | MessageState of the SMS that will be queried |
System.AsyncCallback | asyncCallback | The callback to be invoked upon completion, optional |
System.Object | asyncState | The state object to be stored against the ReadMessageListAsyncResult, optional |
Returns
Type | Description |
---|---|
ListTextMessagesAsyncResult | The IMEIAsyncResult |
ReadTextMessage(Int32, Boolean)
Requests to read the text message in the specified position.
Declaration
public TextMessage ReadTextMessage(int memoryPosition, bool markAsRead = true)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | memoryPosition | Position in memory where the message is stored |
System.Boolean | markAsRead | Whether unread messages will be marked as read |
Returns
Type | Description |
---|---|
TextMessage |
SendTextMessageAsync(String, String, AsyncCallback, Object)
Starts an asynchronous operation to send a text message
Declaration
public SendTextMessageAsyncResult SendTextMessageAsync(string destinationNumber, string text, AsyncCallback asyncCallback = null, object asyncState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | destinationNumber | Destination phone number. Numbers only, no spaces, punctuation or other chars accepted. Number MUST ALWAYS include the country code preceded with international prefix '+' or '00'. |
System.String | text | Message text |
System.AsyncCallback | asyncCallback | The callback to be invoked upon completion, optional |
System.Object | asyncState | The state object to be stored against the SendMessageAsyncResult, optional. |
Returns
Type | Description |
---|---|
SendTextMessageAsyncResult | The IMEIAsyncResult |
Events
SmsReceived
Event raised when the module receives a new SMS message.
Declaration
public event SmsProvider.SmsReceivedHandler SmsReceived
Event Type
Type | Description |
---|---|
SmsProvider.SmsReceivedHandler |
SmsStatusReceived
Event raised when the module receives a new SMS message.
Declaration
public event SmsProvider.SmsStatusReceivedHandler SmsStatusReceived
Event Type
Type | Description |
---|---|
SmsProvider.SmsStatusReceivedHandler |