Package Exports

nativescript-phone

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nativescript-phone) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NativeScript Phone

A NativeScript module providing phone actions for Android and iOS.

Installation

Run npm install nativescript-phone --save from your project's app directory:

.
├── app  <------------------------------ run npm install from here
│   ├── App_Resources
│   │   ├── android
│   │   └── ios
│   ├── app.css
│   ├── app.js
│   ├── main-page.js
│   ├── main-page.xml
│   ├── node_modules
│   │   └── nativescript-phone <-- The install will place the module's code here
│   │       └── ...
│   └── package.json <----------------- The install will register “nativescript-phone” as a dependency here
│   └── tns_modules
│       └── ...
└── platforms
    ├── android
    └── ios

As is, using npm within NativeScript is still experimental, so it's possible that you'll run into some issues. A more complete solution is in the works, and you can check out this issue for an update on its progress and to offer feedback.

If npm doesn't end up working for you, you can just copy and paste this repo's phone-common.js, phone.android.js, and phone.ios.js files into your app and reference them directly.

Android

To dial the phone without user interaction on Android your app must request permission to dial. To do so, add the following line to your project's AndroidManifest.xml:

<uses-permission android:name="android.permission.CALL_PHONE" />

Usage

To use the phone module you must first require() it from your project's node_modules directory:

var phone = require( "./node_modules/nativescript-phone/phone" );

After you have a reference to the module you can then call the available methods.

Methods

dial: initiate a phone call

Parameters

telNum: Phone number to dial.
prompt: Boolean to enable OS specific confirmation before dialing.

For example, the code below dials the number without showing the device specific confirmation prompt:

// my-page.js
var phone = require( "/path/to/node_modules/nativescript-phone" );
phone.dial("212-555-1234",false);

sms: open the OS specific SMS app

Parameters

smsNum: SMS number to use.
messageText: String to send. - Not supported on iOS at this time.

For example, the code below opens the sms app for the provided number:

// my-page.js
var phone = require( "/path/to/node_modules/nativescript-phone" );
phone.sms("212-555-1234","My message");