From fbd484583a2556ebeae80b6350084928e23ab078 Mon Sep 17 00:00:00 2001 From: Ibrahim Hadeed Date: Sat, 12 Mar 2016 19:18:08 -0500 Subject: [PATCH] docs(sms): update param types --- src/plugins/sms.ts | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/plugins/sms.ts b/src/plugins/sms.ts index a389c0dde..1877cde90 100644 --- a/src/plugins/sms.ts +++ b/src/plugins/sms.ts @@ -1,5 +1,8 @@ import {Plugin, Cordova} from './plugin'; +/** + * Options for sending an SMS + */ export interface smsOptions { /** @@ -43,12 +46,10 @@ 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} + * @param number {string|Array} Phone number + * @param message {string} Message + * @param options {smsOptions} Options + * @returns {Promise} Resolves promise when the SMS has been sent */ @Cordova() static send(