Skip to content

Latest commit

 

History

History
96 lines (77 loc) · 3.53 KB

README.md

File metadata and controls

96 lines (77 loc) · 3.53 KB
Raw

SMS reception plugin for Phonegap

By Pierre-Yves Orban

This Android Phonegap plugin allows you to receive incoming SMS. You have the possibility to stop the message broadcasting and, thus, avoid theincoming message native popup.

This plugin was successfully tested with Phonegap 2.5 and Android 4.2.2 (on a Samsung Galaxy Nexus device).

Adding this plugin to your project

  1. (Make sure you are using Phonegap > 2.0)
  2. Move SmsInboxPlugin.js to your project's www folder and include a reference to it in your html files.
  3. Add the java files from src to your project's src hierarchy
  4. Reference the plugin in your res/config.xml file <plugin name="SmsInboxPlugin" value="org.apache.cordova.plugin.SmsInboxPlugin"/>
  5. Ensure that your manifest contains the necessary permissions to send SMS messages: <uses-permission android:name="android.permission.RECEIVE_SMS" />

Using the plugin

To instantiate the plugin object:

var smsInboxPlugin = cordova.require('cordova/plugin/smsinboxplugin');

isSupported

Check if the SMS technology is supported by the device.

Example:

  smsInboxPlugin.isSupported ((function(supported) {
    if(supported) 
      alert("SMS supported !");
    else
      alert("SMS not supported");
  }), function() {
    alert("Error while checking the SMS support");
  });

startReception

Start the SMS receiver waiting for incoming message The success callback function will be called everytime a new message is received. The given parameter is the received message formatted such as: phoneNumber>message (Exemple: +32472345678>Hello World) The error callback is called if an error occurs.

Example:

  smsInboxPlugin.startReception (function(msg) {
    alert(msg);
  }, function() {
    alert("Error while receiving messages");
  });

stopReception

Stop the SMS receiver

Example:

  smsInboxPlugin.stopReception (function() {
    alert("Correctly stopped");
  }, function() {
    alert("Error while stopping the SMS receiver");
  });

Aborting a broadcast

If you abort the broadcast using this plugin (see broadcast boolean variable in the org.apache.cordova.plugin.SmsReceiver), the SMS will not be broadcast to other applications like the native SMS app. So ... be careful !

A good way to manage this is to stop the sms reception when the onPause event is fired and, when the onResume event is fired, restart the reception.

Licence

The MIT License

Copyright (c) 2013 Pierre-Yves Orban

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.