public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

docs(sms): update param types

Browse Source
This commit is contained in:
Ibrahim Hadeed 2016-03-12 19:18:08 -05:00
parent 959cf288e4
commit fbd484583a
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/plugins/sms.ts
View File

@ -1,5 +1,8 @@
import {Plugin, Cordova} from './plugin'; import {Plugin, Cordova} from './plugin';
/**
* Options for sending an SMS
*/
export interface smsOptions { export interface smsOptions {
/** /**
@ -43,12 +46,10 @@ export class SMS {
/** /**
* Sends sms to a number * Sends sms to a number
* @param number [string or array of strings] Phone number * @param number {string|Array<string>} Phone number
* @param message [string] Message * @param message {string} Message
* @param options [object] Options * @param options {smsOptions} Options
* @param options.replaceLineBreaks [boolean] Set to true to replace \n by a new line. Default: false * @returns {Promise<any>} Resolves promise when the SMS has been sent
* @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() @Cordova()
static send( static send(