Urban Airship PhoneGap/Cordova Plugin

Platform Support

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

Version Requirements

This plugin is meant to work with PhoneGap 3.0.0+ and the latest version of the Urban Airship library. More documentation and integration guides for IOS and Android are availble on our website.

Older PhoneGap versions

A older version of the plugin for Phonegap 2.6 - 2.9 can be found here.

Contributing Code

We accept pull requests! If you would like to submit a pull request, please fill out and submit a Code Contribution Agreement (http://urbanairship.com/legal/contribution-agreement/).

Migration

A migration guide for newer releases of the plugin can be found here.

Installation

Automatic Installation using PhoneGap/Cordova CLI (iOS and Android)

1. Install this plugin using PhoneGap/Cordova cli:

phonegap local plugin add https://github.com/urbanairship/phonegap-ua-push.git

2. Modify the www/config.xml directory to contain (replacing with your configuration settings):

    <!-- Urban Airship app credentials -->
    <preference name="com.urbanairship.production_app_key" value="PRODUCTION_APP_KEY" />
    <preference name="com.urbanairship.production_app_secret" value="PRODUCTION_APP_SECRET" />
    <preference name="com.urbanairship.development_app_key" value="DEVELOPMENT_APP_KEY" />
    <preference name="com.urbanairship.development_app_secret" value="DEVELOPMENT_APP_SECRET" />
   
    <!-- If the app is in production or not -->
    <preference name="com.urbanairship.in_production" value="true | false" />
   
    <!-- Enable push when the application launches (instead of waiting for enablePush js call).  Defaults to false -->
    <preference name="com.urbanairship.enable_push_onlaunch" value="true | false" />
   
    <!-- Only required for Android. -->
    <preference name="com.urbanairship.gcm_sender" value="GCM_SENDER_ID" />
   

3. If your app supports Android API < 14, then you have to manually instrument any Android Activities to have proper analytics.
   See Instrumenting Android Analytics.

iOS manual installation (unnecessary if installed automatically)

1. Add src/ios/PushNotificationPlugin to your project

2. Copy src/ios/Airship to your projects directory

3. Add Airship as a Header search path (Project -> Build Settings -> Header Search Path)

4. Add Airship/libUAirship-*.a as a library (Target -> Build Phases -> Link Binary With Libraries)

5. Make sure the following frameworks are linked (Target -> Build Phases -> Link Binary With Libraries):

    CFNetwork.framework
    CoreGraphics.framework
    Foundation.framework
    MobileCoreServices.framework
    Security.framework
    SystemConfiguration.framework
    UIKit.framework
    libz.dylib
    libsqlite3.dylib
    CoreTelephony.framework
    CoreLocation.framework
    AudioToolbox.framework
    StoreKit.framework
   

6. Modify the cordova config.xml file to include the PushNotificationPlugin and preferences:

    <feature name="PushNotificationPlugin">
        <param name="ios-package" value="PushNotificationPlugin" />
        <param name="onload" value="true" />
    </feature>
    
     <!-- Urban Airship app credentials -->
    <preference name="com.urbanairship.production_app_key" value="PRODUCTION_APP_KEY" />
    <preference name="com.urbanairship.production_app_secret" value="PRODUCTION_APP_SECRET" />
    <preference name="com.urbanairship.development_app_key" value="DEVELOPMENT_APP_KEY" />
    <preference name="com.urbanairship.development_app_secret" value="DEVELOPMENT_APP_SECRET" />
   
    <!-- If the app is in production or not -->
    <preference name="com.urbanairship.in_production" value="true | false" />
   
    <!-- Enable push when the application launches (instead of waiting for enablePush js call).  Defaults to false -->
    <preference name="com.urbanairship.enable_push_onlaunch" value="true | false" />
   

7. Copy www/PushNotification.js into the project's www directory

8. Require the PushNotification module var PushNotification = cordova.require('<Path to PushNotification.js>')

Android manual installation (unnecessary if installed automatically)

1. Copy src/Android/*.java files to your projects src/com/urbanairship/phonegap/ directory

2. Copy src/Android/urbanairship-lib-*.jar to your projects libs directory

3. Modify the AndroidManifest.xml to include these permissions:

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.VIBRATE" />
    <uses-permission android:name="android.permission.GET_ACCOUNTS" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
   
    <!-- MODIFICATION REQUIRED, replace $PACKAGE_NAME with your apps package name -->
    <uses-permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE" />
   
    <!-- MODIFICATION REQUIRED, replace $PACKAGE_NAME with your apps package name -->
    <permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE" android:protectionLevel="signature" />
   

4. Modify the AndroidManifest.xml Application section to include:

    <receiver android:name="com.urbanairship.phonegap.PushReceiver" />
    <receiver android:name="com.urbanairship.CoreReceiver" />
    <receiver android:name="com.urbanairship.push.GCMPushReceiver" android:permission="com.google.android.c2dm.permission.SEND">        
        <intent-filter>
            <action android:name="com.google.android.c2dm.intent.RECEIVE" />
            <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
            <!-- MODIFICATION REQUIRED, replace $PACKAGE_NAME with your apps package name -->
            <category android:name="$PACKAGE_NAME" /> 
        </intent-filter>
    </receiver>
    
    <meta-data android:name="com.urbanairship.autopilot" android:value="com.urbanairship.phonegap.PushAutopilot" /> 
    
    <service android:name="com.urbanairship.push.PushService" android:label="Push Notification Service"/>
    <service android:name="com.urbanairship.push.PushWorkerService" android:label="Push Notification Worker Service"/>
    <service android:name="com.urbanairship.analytics.EventService" android:label="Event Service"/>
    
    <provider android:name="com.urbanairship.UrbanAirshipProvider"
        <!-- MODIFICATION REQUIRED, replace $PACKAGE_NAME with your apps package name -->
        android:authorities="$PACKAGE_NAME.urbanairship.provider" 
        android:exported="false"
        android:multiprocess="true" />
    
    <service android:name="com.urbanairship.location.LocationService" android:label="Segments Service"/>
   

5. Modify the cordova config.xml file to include the PushNotificationPlugin:

    <feature name="PushNotificationPlugin">
        <param name="android-package" value="com.urbanairship.phonegap.PushNotificationPlugin" />
        <param name="onload" value="true" />
    </feature>
   
     <!-- Urban Airship app credentials -->
    <preference name="com.urbanairship.production_app_key" value="PRODUCTION_APP_KEY" />
    <preference name="com.urbanairship.production_app_secret" value="PRODUCTION_APP_SECRET" />
    <preference name="com.urbanairship.development_app_key" value="DEVELOPMENT_APP_KEY" />
    <preference name="com.urbanairship.development_app_secret" value="DEVELOPMENT_APP_SECRET" />
   
    <!-- If the app is in production or not -->
    <preference name="com.urbanairship.in_production" value="true | false" />
   
    <!-- Enable push when the application launches (instead of waiting for enablePush js call).  Defaults to false -->
    <preference name="com.urbanairship.enable_push_onlaunch" value="true | false" />
   
    <!-- Only required for Android. -->
    <preference name="com.urbanairship.gcm_sender" value="GCM_SENDER_ID" />
   

6. If your app supports Android API < 14 (pre ICS), then need to manually instrument any Android Activities to get proper analytics.
   See Instrumenting Android Analytics.

7. Copy www/PushNotification.js into the project's www directory

8. Require the PushNotification module var PushNotification = cordova.require('<Path to PushNotification.js>')

Example

A full example can be found in Examples. To run it, copy the files:

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

Basic Example

// Register for any urban airship events
document.addEventListener("urbanairship.registration", function (event) {
    if (event.error) {
        console.log('there was an error registering for push notifications');
    } else {
        console.log("Registered with ID: " + event.pushID);
    } 
}, false)

document.addEventListener("urbanairship.push", function (event) {
    console.log("Incoming push: " + event.message)
}, false)

// Set tags on a device, that you can push to
// https://docs.urbanairship.com/display/DOCS/Server%3A+Tag+API
PushNotification.setTags(["loves_cats", "shops_for_games"], function () {
    PushNotification.getTags(function (obj) {
        obj.tags.forEach(function (tag) {
            console.log("Tag: " + tag);
        });
    });
});

// Set an alias, this lets you tie a device to a user in your system
// https://docs.urbanairship.com/display/DOCS/Server%3A+iOS+Push+API#ServeriOSPushAPI-Alias
PushNotification.setAlias("awesomeuser22", function () {
    PushNotification.getAlias(function (alias) {
        console.log("The user formerly known as " + alias)
    });
});

// Check if push is enabled
PushNotification.isPushEnabled(function (enabled) {
    if (enabled) {
        console.log("Push is enabled! Fire away!");
    }
})

Data objects

The Urban Airship javascript API provides standard instances for some of our data. This allows us to clearly explain what kind of data we're working with when we pass it around throughout the API.

Push

Push = {
    message: "Your team just scored!",
    extras: {
        "url": "/game/5555"
    }
}

Quiet Time

// Quiet time set to 10PM - 6AM
QuietTime = {
    startHour: 22,
    startMinute: 0,
    endHour: 6,
    endMinute: 0
}

A push is an object that contains the data associated with a Push. The extras dictionary can contain arbitrary key and value data, that you can use inside your application.

API

All methods without a return value return undefined

Top-level calls

enablePush()

Enable push on the device. This sends a registration to the backend server.

disablePush()

Disable push on the device. You will no longer be able to recieve push notifications.

enableLocation()

Enable location updates on the device.

disableLocation()

Disable location updates on the device.

enableBackgroundLocation()

Enable background location updates on the device.

disableBackgroundLocation()

Disable background location updates on the device.

registerForNotificationTypes(bitmask)

Note:: iOS Only

On iOS, registration for push requires specifying what combination of badges, sound and alerts are desired. This function must be explicitly called in order to begin the registration process. For example:

PushNotification.registerForNotificationTypes(PushNotification.notificationType.sound | PushNotification.notificationType.alert)

Available notification types:

• notificationType.sound
• notificationType.alert
• notificationType.badge

Status Functions

Callback arguments: (Boolean status)

All status callbacks are passed a boolean indicating the result of the request:

PushNotification.isPushEnabled(function (has_push) {
    if (has_push) {
        $('#pushEnabled').prop("checked", true)
    }
})

isPushEnabled(callback)

Callback arguments (Boolean enabled)

Indicates whether push is enabled.

isSoundEnabled(callback)

Note: Android Only

Callback arguments: (Boolean enabled)

Indicates whether sound is enabled.

isVibrateEnabled(callback)

Note: Android Only

Callback arguments: (Boolean enabled)

Indicates whether vibration is enabled.

isQuietTimeEnabled(callback)

Callback arguments: (Boolean enabled)

Indicates whether Quiet Time is enabled.

isLocationEnabled(callback)

Callback arguments: (Boolean enabled)

Indicates whether location is enabled.

isBackgroundLocationEnabled(callback)

Callback arguments: (Boolean enabled)

Indicates whether background location updates are enabled.

isInQuietTime(callback)

Callback arguments: (Boolean inQuietTime)

Indicates whether Quiet Time is currently in effect.

Getters

getIncoming(callback)

Callback arguments: (Push incomingPush)

Get information about the push that caused the application to be launched. When a user clicks on a push to launch your app, this functions callback will be passed a Push object consisting of the alert message, and an object containing extra key/value pairs. Otherwise the incoming message and extras will be an empty string and an empty object, respectively.

PushNotification.getIncoming(function (incoming) {
    if (incoming.message) {
        alert("Incoming push message: " + incoming.message;
    }

    if (incoming.extras.url) {
        showPage(incoming.extras.url);
    }
})

getPushID(callback)

Callback arguments: (String id)

Get the push identifier for the device. The push ID is used to send messages to the device for testing, and is the canoncial identifer for the device in Urban Airship.

Note: iOS will always have a push identifier. Android will always have one once the application has had a successful registration.

getQuietTime(callback)

Callback arguments: (QuietTime currentQuietTime)

Get the current quiet time.

getTags(callback)

Callback arguments: (Array currentTags)

Get the current tags.

getAlias(callback)

Callback arguments: (String currentAlias)

Get the current tags.

Setters

setTags(Array tags, callback)

Set tags for the device.

setAlias(String alias, callback)

Set alias for the device.

setSoundEnabled(Boolean enabled, callback)

Note: Android Only, iOS sound settings come in the push

Set whether the device makes sound on push.

setVibrateEnabled(Boolean enabled, callback)

Note: Android Only

Set whether the device vibrates on push.

setQuietTimeEnabled(Boolean enabled, callback)

Set whether quiet time is on.

setQuietTime(QuietTime newQuietTime, callback)

Set the quiet time for the device.

setAutobadgeEnabled(Boolean enabled, callback)

Note: iOS only

Set whether the UA Autobadge feature is enabled.

setBadgeNumber(Int badge, callback)

Note: iOS only

Set the current application badge number

resetBadge(callback)

Note: iOS only

Reset the badge number to zero

Location

recordCurrentLocation(callback)

Report the location of the device.

Events

Note: If your application supports Android and it listens to any of the events, you should start listening for events on both 'deviceReady' and 'resume' and stop listening for events on 'pause'.
This will prevent the events from being handled in the background.

Incoming Push

Event:

{
    message: <Alert Message>,
    extras: <Extras Dictionary>
}

This event is triggered when a push notification is received.

document.addEventListener('urbanairship.push', function(event) {
    alert(event.message);
});

Registration

Event:

{
    error: <Error message when registration failed>,
    pushID: <Push address>
}

This event is triggered when your application receives a registration response from Urban Airship.

document.addEventListener('urbanairship.registration', function(event) {
    if (event.error) {
        console.log('There was an error registering for push notifications.');
    } else {
        console.log("Registered with ID: " + event.pushID);
    } 
});