Merge pull request #22 from ihadeed/add-sms

Add sms
This commit is contained in:
Tim Lancina 2016-03-10 10:13:28 -06:00
commit 62cba17a75

63
src/plugins/sms.ts Normal file
View File

@ -0,0 +1,63 @@
import {Plugin, Cordova} from './plugin';
export interface smsOptions {
/**
* Set to true to replace \n by a new line. Default: false
*/
replaceLineBreaks : boolean,
android : smsOptionsAndroid
}
export interface smsOptionsAndroid {
/**
* Set to "INTENT" to send SMS with the native android SMS messaging. Leaving it empty will send the SMS without opening any app.
*/
intent : string
}
/**
*
*
* Requires Cordova plugin: cordova-plugin-sms. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin).
*
* ```
* cordova plugin add https://github.com/cordova-sms/cordova-sms-plugin.git
* ```
*
* @usage
* ```js
*
*
* ```
*/
@Plugin({
plugin: 'https://github.com/cordova-sms/cordova-sms-plugin.git',
pluginRef: 'sms'
})
export class SMS {
/**
* Sends sms to a number
* @param number [string or array of strings] Phone number
* @param message [string] Message
* @param options [object] Options
* @param options.replaceLineBreaks [boolean] Set to true to replace \n by a new line. Default: false
* @param options.android.intent [string] Set to "INTENT" to send SMS with the native android SMS messaging. Leaving it empty will send the SMS without opening any app.
* @returns {Promise<any>}
*/
@Cordova()
static send(number : any, message : string, options? : smsOptions) : Promise<any> {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
}