capacitor-sms-sender v1.1.0

capacitor-sms-sender

Send SMS directly from capacitor app

Install

npm install capacitor-sms-sender
npx cap sync

Example

import { SmsSender } from 'capacitor-sms-sender'

let opts = {
    id: 1,
    sim: 0,
    phone: '+123020021',
    text: 'Hi There'
}
SmsSender.send(opts)
    .then(res => {
        console.log(res)
    })

SmsSender.addListener('smsSenderDelivered', res => {
    console.log(res)
})

API

• send(...)
• checkPermissions()
• requestPermissions()
• addListener('smsSenderStatusUpdated', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

send(...)

send(opts: SmsSenderOptions) => Promise<SmsSenderResult>

Send a text sms to a number from a specified sim index

Returns: Promise<SmsSenderResult>

Since: 1.0.0

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Check status of permissions

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request the required permissions

Returns: Promise<PermissionStatus>

addListener('smsSenderStatusUpdated', ...)

addListener(eventName: 'smsSenderStatusUpdated', listenerFunc: (result: SmsSenderResult) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for sms status update

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.1.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all registered listeners

Since: 1.0.0

Interfaces

SmsSenderResult

SmsSenderOptions

PermissionStatus

PluginListenerHandle

Type Aliases

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'