Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ayush-Rajniwal/cap-read-sms
Capacitor Plugin to read user's SMS
https://github.com/Ayush-Rajniwal/cap-read-sms
Last synced: 24 days ago
JSON representation
Capacitor Plugin to read user's SMS
- Host: GitHub
- URL: https://github.com/Ayush-Rajniwal/cap-read-sms
- Owner: Ayush-Rajniwal
- Created: 2021-10-09T18:16:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-21T17:58:08.000Z (about 3 years ago)
- Last Synced: 2024-09-28T15:17:02.417Z (3 months ago)
- Language: Java
- Size: 104 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-capacitor - Read sms - Read the user's SMS with their permission. (Other plugins)
README
# cap-read-sms
Capacitor Plugin to read the user's SMS (with their permission)
### [Demo](https://github.com/Ayush-Rajniwal/Capacitor-read-sms-plugin-demo)
## Install
```bash
npm install cap-read-sms
```
Sync the plugin with capacitor.
```bash
npx cap sync
```
## Supported Platforms
| Platforms | Supported |
| --------- | --------- |
| Android | ✅ |
| iOS | ❌ |
| Web | 🤷♂️ |
## API
- [`getSMS(...)`](#getsms)
- [`checkPermission()`](#checkpermission)
- [`requestPermission()`](#requestpermission)
- [Interfaces](#interfaces)
### getSMS(...)
```typescript
getSMS(options: { timestamp?: string; pageSize?: number; sender?: string; }) => any
```
| Param | Type |
| ------------- | ------------------------------------------------------------------------ |
| **`options`** | { timestamp?: string; pageSize?: number; sender?: string; } |
**Returns:** any
---
### checkPermission()
```typescript
checkPermission() => any
```
**Returns:** any
---
### requestPermission()
```typescript
requestPermission() => any
```
**Returns:** any
---
### Interfaces
#### SMS_INTERFACE
| Prop | Type |
| ------------------------ | ------------------- |
| **`address`** | string |
| **`body`** | string |
| **`creator`** | string |
| **`date`** | string |
| **`date_sent`** | string |
| **`error_code`** | string |
| **`ipmsg_id`** | string |
| **`locked`** | string |
| **`protocol`** | string |
| **`read`** | string |
| **`reply_path_present`** | string |
| **`seen`** | string |
| **`service_center`** | string |
| **`status`** | string |
| **`sub_id`** | string |
| **`thread_id`** | string |
| **`type`** | string |
| **`_id`** | string |