awesome-cordova-plugins/src/plugins/sms.ts

61 lines
1.4 KiB
TypeScript
Raw Normal View History

2016-03-07 02:23:30 +08:00
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).
*
* ```
2016-03-07 03:51:26 +08:00
* cordova plugin add https://github.com/cordova-sms/cordova-sms-plugin.git
2016-03-07 02:23:30 +08:00
* ```
*
* @usage
* ```js
*
*
* ```
*/
@Plugin({
2016-03-07 03:51:26 +08:00
plugin: 'https://github.com/cordova-sms/cordova-sms-plugin.git',
2016-03-07 02:23:30 +08:00
pluginRef: 'sms'
})
export class SMS {
/**
* Sends sms to a number
2016-03-07 03:51:26 +08:00
* @param number [string or array of strings] Phone number
2016-03-07 02:23:30 +08:00
* @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>}
*/
2016-03-07 03:51:26 +08:00
@Cordova()
static send(
number: string | string[],
message: string,
options?: smsOptions
): Promise<any> { return }
2016-03-07 02:23:30 +08:00
}