Notification

About this version

This page preserves the official documentation for edge snapshot at Cordova 3.0.0. Commands, supported platforms and API behavior below belong to that historical version. The edge URL changed over time; this is a named repository snapshot, not an assertion about its last live contents. For active projects, consult the current Apache Cordova documentation.

Original source: Notification

Visual, audible, and tactile device notifications.

Methods

notification.alert
notification.confirm
notification.prompt
notification.beep
notification.vibrate

Permissions

Android

app/res/xml/config.xml

<plugin name="Notification" value="org.apache.cordova.Notification"/>

app/AndroidManifest.xml

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

BlackBerry WebWorks

www/plugins.xml

<plugin name="Notification" value="org.apache.cordova.notification.Notification" />

www/config.xml

<feature id="blackberry.ui.dialog" />

iOS

config.xml

<plugin name="Notification" value="CDVNotification" />

Windows Phone

No permissions are required.

Tizen

No permissions are required.

Original source: notification.alert

notification.alert

Shows a custom alert or dialog box.

navigator.notification.alert(message, alertCallback, [title], [buttonName])

message: Dialog message. (String)
alertCallback: Callback to invoke when alert dialog is dismissed. (Function)
title: Dialog title. (String) (Optional, defaults to Alert)
buttonName: Button name. (String) (Optional, defaults to OK)

Description

Most Cordova implementations use a native dialog box for this feature, but some platforms use the browser's alert function, which is typically less customizable.

Supported Platforms

Android
BlackBerry WebWorks (OS 5.0 and higher)
iOS
Tizen
Windows Phone 7 and 8
Windows 8

Quick Example

// Android / BlackBerry WebWorks (OS 5.0 and higher) / iOS / Tizen
//
function alertDismissed() {
    // do something
}

navigator.notification.alert(
    'You are the winner!',  // message
    alertDismissed,         // callback
    'Game Over',            // title
    'Done'                  // buttonName
);

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Notification Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // Empty
    }

    // alert dialog dismissed
        function alertDismissed() {
            // do something
        }

    // Show a custom alertDismissed
    //
    function showAlert() {
        navigator.notification.alert(
            'You are the winner!',  // message
            alertDismissed,         // callback
            'Game Over',            // title
            'Done'                  // buttonName
        );
    }

    </script>
  </head>
  <body>
    <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
  </body>
</html>

Windows Phone 7 and 8 Quirks

There is no built-in browser alert, but you can bind one as follows to call alert() in the global scope:
```
  window.alert = navigator.notification.alert;
```
Both alert and confirm are non-blocking calls, results of which are only available asynchronously.

Original source: notification.beep

notification.beep

The device plays a beep sound.

navigator.notification.beep(times);

times: The number of times to repeat the beep. (Number)

Supported Platforms

Android
BlackBerry WebWorks (OS 5.0 and higher)
iOS
Tizen
Windows Phone 7 and 8

Quick Example

// Beep twice!
navigator.notification.beep(2);

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Notification Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // Empty
    }

    // Show a custom alert
    //
    function showAlert() {
        navigator.notification.alert(
            'You are the winner!',  // message
            'Game Over',            // title
            'Done'                  // buttonName
        );
    }

    // Beep three times
    //
    function playBeep() {
        navigator.notification.beep(3);
    }

    // Vibrate for 2 seconds
    //
    function vibrate() {
        navigator.notification.vibrate(2000);
    }

    </script>
  </head>
  <body>
    <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
    <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
    <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
  </body>
</html>

Android Quirks

Android plays the default Notification ringtone specified under the Settings/Sound & Display panel.

Windows Phone 7 and 8 Quirks

Relies on a generic beep file from the Cordova distribution.

Tizen Quirks

Tizen implements beeps by playing an audio file via the media API.
The beep file must be short, must be located in a sounds sub-directory of the application's root directory, and must be named beep.wav.

Original source: notification.confirm

notification.confirm

Displays a customizable confirmation dialog box.

navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])

message: Dialog message. (String)
confirmCallback: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). (Function)
title: Dialog title. (String) (Optional, defaults to Confirm)
buttonLabels: Comma-separated string specifying button labels. (String) (Optional, defaults to OK,Cancel)

Description

The notification.confirm method displays a native dialog box that is more customizable than the browser's confirm function.

confirmCallback

The confirmCallback executes when the user presses one of the buttons in the confirmation dialog box.

The callback takes the argument buttonIndex (Number), which is the index of the pressed button. Note that the index uses one-based indexing, so the value is 1, 2, 3, etc.

Supported Platforms

Android
BlackBerry WebWorks (OS 5.0 and higher)
iOS
Tizen
Windows Phone 7 and 8
Windows 8

Quick Example

// process the confirmation dialog result
function onConfirm(buttonIndex) {
    alert('You selected button ' + buttonIndex);
}

// Show a custom confirmation dialog
//
function showConfirm() {
    navigator.notification.confirm(
        'You are the winner!', // message
         onConfirm,            // callback to invoke with index of button pressed
        'Game Over',           // title
        'Restart,Exit'         // buttonLabels
    );
}

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Notification Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // Empty
    }

    // process the confirmation dialog result
    function onConfirm(buttonIndex) {
        alert('You selected button ' + buttonIndex);
    }

    // Show a custom confirmation dialog
    //
    function showConfirm() {
        navigator.notification.confirm(
            'You are the winner!', // message
             onConfirm,            // callback to invoke with index of button pressed
            'Game Over',           // title
            'Restart,Exit'         // buttonLabels
        );
    }

    </script>
  </head>
  <body>
    <p><a href="#" onclick="showConfirm(); return false;">Show Confirm</a></p>
  </body>
</html>

Windows Phone 7 and 8 Quirks

There is no built-in browser function for window.confirm, but you can bind it by assigning:
```
  window.confirm = navigator.notification.confirm;
```
Calls to alert and confirm are non-blocking, so the result is only available asynchronously.

Original source: notification.prompt

notification.prompt

Shows a customizable prompt dialog box.

navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])

message: Dialog message. (String)
promptCallback: Callback to invoke when a button is pressed. (Function)
title: Dialog title (String) (Optional, defaults to Prompt)
buttonLabels: Array of strings specifying button labels (Array) (Optional, defaults to ["OK","Cancel"])
defaultText: Default textbox input value (String) (Optional, Default: "Default text")

Description

The notification.prompt method displays a native dialog box that is more customizable than the browser's prompt function.

promptCallback

The promptCallback executes when the user presses one of the buttons in the prompt dialog box. The results object passed to the callback contains the following properties:

buttonIndex: The index of the pressed button. (Number) Note that the index uses one-based indexing, so the value is 1, 2, 3, etc.
input1: The text entered in the prompt dialog box. (String)

Supported Platforms

Android
iOS

Quick Example

// process the promp dialog results
function onPrompt(results) {
    alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
}

// Show a custom prompt dialog
//
function showPrompt() {
    navigator.notification.prompt(
        'Please enter your name',  // message
        onPrompt,                  // callback to invoke
        'Registration',            // title
        ['Ok','Exit'],             // buttonLabels
        'Jane Doe'                 // defaultText
    );
}

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Notification Prompt Dialog Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // Empty
    }

    // process the promptation dialog result
    function onPrompt(results) {
        alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
    }

    // Show a custom prompt dialog
    //
    function showPrompt() {
        navigator.notification.prompt(
            'Please enter your name',  // message
            onPrompt,                  // callback to invoke
            'Registration',            // title
            ['Ok','Exit'],             // buttonLabels
            'Jane Doe'                 // defaultText
        );
    }

    </script>
  </head>
  <body>
    <p><a href="#" onclick="showPrompt(); return false;">Show Prompt</a></p>
  </body>
</html>

Android Quirks

Android supports a maximum of three buttons, and ignores any more than that.
On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.

Original source: notification.vibrate

notification.vibrate

Vibrates the device for the specified amount of time.

navigator.notification.vibrate(milliseconds)

time: Milliseconds to vibrate the device, where 1000 milliseconds equals 1 second. (Number)

Supported Platforms

Android
BlackBerry WebWorks (OS 5.0 and higher)
iOS
Windows Phone 7 and 8

Quick Example

// Vibrate for 2.5 seconds
//
navigator.notification.vibrate(2500);

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Notification Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // Empty
    }

    // Show a custom alert
    //
    function showAlert() {
        navigator.notification.alert(
            'You are the winner!',  // message
            'Game Over',            // title
            'Done'                  // buttonName
        );
    }

    // Beep three times
    //
    function playBeep() {
        navigator.notification.beep(3);
    }

    // Vibrate for 2 seconds
    //
    function vibrate() {
        navigator.notification.vibrate(2000);
    }

    </script>
  </head>
  <body>
    <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
    <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
    <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
  </body>
</html>

iOS Quirks

time: Ignores the specified time and vibrates for a pre-set amount of time.

  navigator.notification.vibrate();
  navigator.notification.vibrate(2500);   // 2500 is ignored

Sources & archive notes

Recovered repository material is attributed to its original authors and distributed with its source license. Changes: FreeSoft layout, archive context, navigation, link and image locations. Apache License 2.0 · Notices and provenance. Editorial material is labeled separately.