cap-read-sms

October 21, 2021 · View on GitHub

Capacitor Plugin to read the user's SMS (with their permission)

Demo

Install

npm install cap-read-sms

Sync the plugin with capacitor.

npx cap sync

Supported Platforms

Platforms	Supported
Android	✅
iOS	❌
Web	🤷‍♂️

API

getSMS(...)
checkPermission()
requestPermission()
Interfaces

getSMS(...)

getSMS(options: { timestamp?: string; pageSize?: number; sender?: string; }) => any

Param	Type
`options`	`{ timestamp?: string; pageSize?: number; sender?: string; }`

Returns: any

checkPermission()

checkPermission() => any

Returns: any

requestPermission()

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`