Giter VIP home page Giter VIP logo

cordova-sms-reader's Introduction

SMS reader for Cordova applications

A simple to use, minimal frills SMS reader for cordova applications.

To keep things simple, only inbox is searched.

Installing

From cordova plugin registry

cordova plugin add cordova-sms-reader

From plugin repository

cordova plugin add https://github.com/rajeevs1992/cordova-sms-reader.git

Supported platforms

  • Android

API Reference

smsreader

getAllSMS(since)

Fetch all SMS since a specified date. The since parameter is optional.

smsreader.getAllSMS()
    .then((sms)=>{
        // Fetches all SMS.
    },
    (err)=>{
        console.error(err);
    });

smsreader.getAllSMS('2019-01-01')
    .then((sms)=>{
        // Fetches all SMS received after 2019-01-01
    },
    (err)=>{
        console.error(err);
    });

smsreader.getAllSMS(new Date(2019, 0, 1))
    .then((sms)=>{
        // Fetches all SMS received after 2019-01-01
    },
    (err)=>{
        console.error(err);
    });

filterSenders(senderids, since)

Fetch all SMS since date, from a list of sender addresses. The since parameter is optional.

The senderid is case sensitive.

smsreader.filterSenders(['123456','01402368'])
    .then((sms)=>{
        // Fetches all SMS from 123456 OR 01402368.
    },
    (err)=>{
        console.error(err);
    });

smsreader.filterSenders(['123456','01402368'], '2019-01-01')
    .then((sms)=>{
        // Fetches all SMS recieved from 123456 OR 01402368 AND receieved after 2019-01-01.
    },
    (err)=>{
        console.error(err);
    });

filterBody(searchtexts, since)

Fetch all SMS since date, filtered by search texts. SMS is returned if ANY of the search string is present in the body. The since parameter is optional.

The search text is case insensitive.

smsreader.filterBody(['hello','alice'])
    .then((sms)=>{
        // Fetches all SMS, with body containing words 'hello' OR 'alice'.
    },
    (err)=>{
        console.error(err);
    });

smsreader.filterBody(['hello','alice'], '2019-01-01')
    .then((sms)=>{
        // Fetches all SMS, with body containing words 'hello' OR 'alice' AND receieved after 2019-01-01.
    },
    (err)=>{
        console.error(err);
    });

filterBodyOrSenders(searchtexts, senderids, since)

Fetch all SMS since date, filtered by search texts or sender ids. SMS is returned if ANY of the search string is present in the body OR is from any of the senderids. The since parameter is optional.

The search text is case insensitive.

smsreader.filterBodyOrSenders(['hello','alice'], ['12456','147589'])
    .then((sms)=>{
        // Fetches all SMS, with body containing words ('hello' OR 'alice') OR (address in ['12456','147589'])
    },
    (err)=>{
        console.error(err);
    });

smsreader.filterBodyOrSenders(['hello','alice'], ['12456','147589'], '2019-01-01')
    .then((sms)=>{
        // Fetches all SMS, with body containing words ('hello' OR 'alice') OR (address in ['12456','147589']) AND receieved after 2019-01-01.
    },
    (err)=>{
        console.error(err);
    });

SMS

The API functions return a Promise resolving to an array of SMS objects, which have the following properties.

  • id : number, A unique id for the SMS, assigned by the android messenger.
  • address : string, The sender address.
  • body : string, The SMS body.
  • date : number, A timestamp of the received date.
  • read : boolean, A flag denoting if SMS is read or not.

Sample response

[
    {
        "id" : 3,
        "address" : "123456",
        "body" : "Hello world",
        "date" : 1546681106290,
        "read" : true
    },
    {
        "id" : 4,
        "address" : "87956",
        "body" : "Hello SMS",
        "date" : 1546681106292,
        "read" : false
    }
]

cordova-sms-reader's People

Contributors

rajeevs1992 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

cordova-sms-reader's Issues

Read SMS sent

Hello,

First of all, thank's for this very useful lib.
I use the library in order to read all the sms received AND sent by the user.
Unfortunately, using getAllSMS() I only get the sms I received, but never the sms sent.

Is this normal comportment for the plugin ?

J4YF7O

Error Throw :Invalid Action

smsreader.getAllSMS()
.then((sms)=>{
alert(sms);
// Fetches all SMS.
},
(err)=>{
alert(err);
console.error(err);
});

build error!

SMSReader.java:40: error: strings in switch are not supported in -source 1.6
switch (action) {
^
(use -source 7 or higher to enable strings in switch)

What should I do?

my jdk version is..

java version "1.8.0_191"
Java(TM) SE Runtime Environment (build 1.8.0_191-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.191-b12, mixed mode)

Please, save my life! Thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.