@aalzehla/capacitor-sms
v0.3.3
Published
Capacitor SMS plugin
Maintainers
Readme
capacitor-sms
Send and Read SMS
Install
npm install capacitor-sms
npx cap syncAPI
send(...)
send(options: SmsSendOptions) => Promise<void>Send the sms
| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | SmsSendOptions |
checkPermissions(...)
checkPermissions(options: SmsPluginPermissions) => Promise<PermissionStatus>| Param | Type |
| ------------- | --------------------------------------------------------------------- |
| options | SmsPluginPermissions |
Returns: Promise<PermissionStatus>
requestPermissions(...)
requestPermissions(options: SmsPluginPermissions) => Promise<PermissionStatus>| Param | Type |
| ------------- | --------------------------------------------------------------------- |
| options | SmsPluginPermissions |
Returns: Promise<PermissionStatus>
Interfaces
SmsSendOptions
| Prop | Type |
| ------------- | --------------------- |
| numbers | string[] |
| text | string |
PermissionStatus
| Prop | Type |
| ------------- | ----------------------------------------------------------- |
| send | PermissionState |
| receive | PermissionState |
| read | PermissionState |
SmsPluginPermissions
| Prop | Type |
| ---------------- | --------------------------------------------------------------- |
| permission | SmsPermissionType |
Type Aliases
PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
SmsPermissionType
'send' | 'receive' | 'read'
