Urban Airship PhoneGap/Cordova Plugin

This plugin supports PhoneGap/Cordova apps running on both iOS and Android.

Resources:

• Getting started guide
• JSDocs
• Migration docs

Contributing Code

We accept pull requests! If you would like to submit a pull request, please fill out and submit a Code Contribution Agreement.

Issues

Please contact support@urbanairship.com for any issues integrating or using this plugin.

Requirements:

• Android GCM Setup
• iOS APNS Setup

Quickstart

1. Install this plugin using PhoneGap/Cordova CLI:

    cordova plugin add urbanairship-cordova
   

2. Modify the config.xml file to set the Android minimum sdk version to 16:

    <platform name="android">
        <preference name="android-minSdkVersion" value="16" />
    </platform> 
   

3. Modify the config.xml file to contain (replacing with your configuration settings):

    <!-- Urban Airship app credentials -->
    <preference name="com.urbanairship.production_app_key" value="Your Production App Key" />
    <preference name="com.urbanairship.production_app_secret" value="Your Production App Secret" />
    <preference name="com.urbanairship.development_app_key" value="Your Development App Key" />
    <preference name="com.urbanairship.development_app_secret" value="Your Development App Secret" />
   
    <!-- Required for Android. -->
    <preference name="com.urbanairship.gcm_sender" value="Your GCM Sender ID" />
   
    <!-- If the app is in production or not -->
    <preference name="com.urbanairship.in_production" value="true | false" />
   
    <!-- Optional config values -->
   
    <!-- Enable push when the application launches -->
    <preference name="com.urbanairship.enable_push_onlaunch" value="true | false" />
    
    <!-- Enable Analytics when the application launches -->
    <!-- Warning: Features that depend on analytics being enabled may not work properly if analytics is disabled (reports, location segmentation, region triggers, push to local time). -->
    <preference name="com.urbanairship.enable_analytics" value="true | false" />
   
    <!-- Override the Android notification icon -->
    <preference name="com.urbanairship.notification_icon" value="ic_notification" />
   
    <!-- Override the Android notification large icon -->
    <preference name="com.urbanairship.notification_large_icon" value="ic_notification_large" />
   
    <!-- Override the Android notification sound (sound file should be in res/raw)-->
    <preference name="com.urbanairship.notification_sound" value="push" />
   
    <!-- Specify the notification accent color for Android API 21+ (Lollipop) -->
    <preference name="com.urbanairship.notification_accent_color" value="#0000ff" />
   
    <!-- Clear the iOS badge on launch -->
    <preference name="com.urbanairship.clear_badge_onlaunch" value="true | false" />
   
    <!-- Enables/disables auto launching the message center when the corresponding push is opened. -->
    <preference name="com.urbanairship.auto_launch_message_center" value="true | false" />
   

4. Enable user notifications

    // Enable user notifications (will prompt the user to accept push notifications)
    UAirship.setUserNotificationsEnabled(true, function (enabled) {
        console.log("User notifications are enabled! Fire away!")
    })

iOS

Enable Push Notifications in the project editor's Capabilities pane:

Sample

A sample can be found in Example. To run it, copy the files:

• Example/index.html to www/index.html
• Example/css/* to www/css
• Example/js/* to www/js

Add the device plugin: cordova plugin add cordova-plugin-device