75 lines
1.7 KiB
TypeScript
75 lines
1.7 KiB
TypeScript
import { Cordova, Plugin } from './plugin';
|
|
|
|
|
|
/**
|
|
* Options for sending an SMS
|
|
*/
|
|
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;
|
|
|
|
}
|
|
|
|
/**
|
|
* @name SMS
|
|
* @description
|
|
*
|
|
* Requires Cordova plugin: cordova-plugin-sms. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin).
|
|
*
|
|
* @usage
|
|
* ```typescript
|
|
* import { SMS } from 'ionic-native';
|
|
*
|
|
*
|
|
* // Send a text message using default options
|
|
* SMS.send('416123456', 'Hello world!');
|
|
* ```
|
|
*/
|
|
@Plugin({
|
|
pluginName: 'SMS',
|
|
plugin: 'cordova-sms-plugin',
|
|
pluginRef: 'sms',
|
|
repo: 'https://github.com/cordova-sms/cordova-sms-plugin',
|
|
platforms: ['Android', 'iOS', 'Windows Phone 8']
|
|
})
|
|
export class SMS {
|
|
|
|
/**
|
|
* Sends sms to a number
|
|
* @param phoneNumber {string|Array<string>} Phone number
|
|
* @param message {string} Message
|
|
* @param options {SmsOptions} Options
|
|
* @returns {Promise<any>} Resolves promise when the SMS has been sent
|
|
*/
|
|
@Cordova()
|
|
static send(
|
|
phoneNumber: string | string[],
|
|
message: string,
|
|
options?: SmsOptions
|
|
): Promise<any> { return; }
|
|
|
|
/**
|
|
* This function lets you know if the app has permission to send SMS
|
|
* @return {Promise<boolean>} returns a promise that resolves with a boolean that indicates if we have permission
|
|
*/
|
|
@Cordova({
|
|
platforms: ['Android']
|
|
})
|
|
static hasPermission(): Promise<boolean> { return; }
|
|
|
|
}
|