@jonz94/capacitor-read-sms

Capacitor Plugin to read SMS

Install

npm install @jonz94/capacitor-read-sms
npx cap sync

API

• getSMS(...)
• checkPermission()
• requestPermission()
• Interfaces
• Type Aliases

getSMS(...)

getSMS(options: { timestamp?: string; pageSize?: number; sender?: string; }) => Promise<{ value: SMS[]; }>

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

Returns: Promise<{ value: SMS[]; }>

---

checkPermission()

checkPermission() => Promise<{ value: PERMISSION; }>

Returns: Promise<{ value: PERMISSION; }>

---

requestPermission()

requestPermission() => Promise<{ value: PERMISSION; }>

Returns: Promise<{ value: PERMISSION; }>

---

Interfaces

SMS

Prop	Type
_id	string
thread_id	string
address	string
date	string
date_sent	string
protocol	string
read	string
status	string
type	string
reply_path_present	string
body	string
error_code	string
creator	string
seen	string
priority	string
sequence_time	string
server_time	string

Type Aliases

PERMISSION

'granted' | 'denied'