correct hash in config

99lives · 99lives · commit f18c2aebc47d · 2013-07-29T12:00:09.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,9 @@
+forge-error.log
 urbanairship_demoapp/hooks/postbuild/uaplugin/AirshipConfig.plist
 urbanairship_demoapp/hooks/postbuild/uaplugin/airshipconfig.properties
 urbanairship_demoapp/local_config.json
 urbanairship_demoapp/.lib/
 urbanairship_demoapp/.template
 urbanairship_demoapp/development/
-forge-error.log
+urbanairship_demoapp/release
+urbanairship_demoapp/misc/
diff --git a/README.md b/README.md
@@ -3,41 +3,13 @@
 plugin for trigger.io platform allowing integration with push messaging service provided by Urban Airship
 Ported and modified with permission, from the official phonegap plugin.
 
-###License (BSD 2-part)
-
-Copyright (c) 2013, On Device Research Ltd.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met: 
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer. 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution. 
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those
-of the authors and should not be interpreted as representing official policies, 
-either expressed or implied, of the FreeBSD Project.
 
 **************************************************************************************
 ****IMPORTANT THIS PLUGIN REQUIRES THE USE OF BUILD HOOKS - SEE BELOW FOR DETAILS!****
 **************************************************************************************
 
 ### project url
-https://github.com/Ansr-io/trigger.io-ua-push
+[https://github.com/Ansr-io/trigger.io-ua-push](https://github.com/Ansr-io/trigger.io-ua-push)
 
 ### project author
 petehobo @ gmail DOT com
@@ -50,68 +22,76 @@ setup urbanship account
 
 Follow setup steps for ios and Android from : 
 
-ios :http://docs.urbanairship.com/build/ios.html
-android : http://docs.urbanairship.com/build/android.html
+[http://docs.urbanairship.com/build/ios.html](http://docs.urbanairship.com/build/ios.html)
+
+[http://docs.urbanairship.com/build/android.html](http://docs.urbanairship.com/build/android.html)
+
 
 You will end with two configured services:
 
-Apple Push Notification Service (APNS)
-& 
+- Apple Push Notification Service (APNS)
+- Google Cloud Messaging (GCM)
 
-Google Cloud Messaging (GCM)
-NB. set ‘gcmSender’ in ‘hooks/postbuild/uaplugin/airshipconfig.properties’ equal to GCM Project Number, 
+NB. set `gcmSender` in `hooks/postbuild/uaplugin/airshipconfig.properties` equal to GCM Project Number, 
 see https://code.google.com/apis/console/ > project overview.
 
+
 ### Build Plugin (optional)
 
 Import the plugin inspectors to your forge workspace.  
 Build and upload the libiary versions of the plugin following:
 
-https://trigger.io/docs/current/api/native_plugins/index.html (Section Building/packaging your plugin)
+[https://trigger.io/docs/current/api/native_plugins/index.html](https://trigger.io/docs/current/api/native_plugins/index.html) (see section 'Building/packaging your plugin').
 
 
 ### Run Test App
 Import the plugin
 Import the demo app /UA
 
-IMPORTANT - USE OF HOOKS.  The Urban Airship system needs to modify the generated forge project during 
+** IMPORTANT - USE OF HOOKS. **  
+The Urban Airship system needs to modify the generated forge project during 
 the build process.  This is accomplished by use of build hooks 
-( https://trigger.io/docs/current/tools/hooks.html ) .  
+[https://trigger.io/docs/current/tools/hooks.html](https://trigger.io/docs/current/tools/hooks.html).  
 When developing your own project you must copy the Hooks folder from the demo project.  
 PLEASE NOTE - special attention will be required if your project uses build hooks. 
+
  Further, the Android version of the plugin makes direct modifications to the generated 
- Android-manifest .xml file - this could potentially cause unexpected results.  
- ***************USE WITH CAUTION**************
+ 
+ `Android-manifest.xml` file - this could potentially cause unexpected results.  
+ 
+** >>> USE WITH CAUTION <<< **
 
 
-Modify local UA settings:
+### Modify local UrbanAirship settings
 
 #### Android
 
-Update the UA settings file in hooks/postbuild/uaplugin/airshipconfig.properties
+Update the UA settings file `hooks/postbuild/uaplugin/airshipconfig.properties`
 
-Open hooks/postbuild/hook.py, and set APP_PACKAGE_NAME to your app package name.
+Open `hooks/postbuild/hook.py`, and set `APP_PACKAGE_NAME` to your app package name.
 
-N.B. package_names is defined in src/config.json.
+N.B. package_names is defined in `src/config.json`.
 - package name must be a valid Java package name (lowercase, no hyphens)
 - package name may not contain underscores - Apple rejects bundle identifiers with underscores as invalid.
 
 
 #### iOS
 
-Update the UA settings file in hooks/postbuild/uaplugin/airshipConfig.plist
+Update the UA settings file `hooks/postbuild/uaplugin/airshipConfig.plist`
+
+
+## API documentation
 
+All methods without a return value return null or undefined.
+
+### enablePush()
+Enable push notifications on the device. This sends a registration request to the backend service.
 
-### API documentation
 
 ```
 forge.urbanairship = {
-    showAlert: function (text, success, error) {
-        // does nothing ????
-        // remove this - or fix it.
-    },
     enablePush: function (success, error) {
-        // Enable push notifications on the device. This sends a registration to the backend service.
+        // Enable push notifications on the device. This sends a registration request to the backend service.
     },
     disablePush: function (success, error) {
         // Disable push notifications on the device. The device will no longer recieve push notifications.
@@ -128,6 +108,23 @@ forge.urbanairship = {
     disableBackgroundLocation: function (success, error) {
         // Disable background location updates on the device.
     },
+    registerForNotificationTypes: function (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:
+        //
+        // push.registerForNotificationTypes(push.notificationType.sound | push.notificationType.alert)
+        //
+        // If your are unfamiliar with bitmasks, see: https://en.wikipedia.org/wiki/Bitmask#Uses_of_bitmasks
+        //
+        // Available notification types:
+        //
+        // notificationType.sound
+        // notificationType.alert
+        // notificationType.badge
+    },
     // ------------------------------------------------------------
     isPushEnabled: function (callback) {
         // Callback arguments : Boolean : enabled
@@ -209,9 +206,74 @@ forge.urbanairship = {
         // Report the location of the device.
     }
 };
+```
+
+## Events
+
+### Incoming Push
+
+This is called when a push is received, but ONLY while the app is active.
+See also getIncoming.
+
+```
 forge.internal.addEventListener("urbanairship.pushReceived", function (data) {
-    // Register for our native push events
-    // this is called when a push is received: ONLY while the app is active
-    // see also getIncoming
+   var txt = 'pushReceived: '+JSON.stringify(d);
+   console.log(txt);
 });
 ```
+
+### Registration
+
+Callback arguments: (Object)
+    ```
+       {
+       valid: Boolean
+       pushID: String
+       }
+    ```
+
+This event is trigerred when a registration response is recieved from UrbanAirship.
+
+```
+var registered = false;
+forge.internal.addEventListener("urbanairship.registration", function (d) {
+        var txt;
+
+        if (!registered) {
+            registered = d;
+            txt = 'registration: '+JSON.stringify(registered);
+            console.log(txt);
+        }
+});
+```
+
+
+
+## License (BSD 2-part)
+
+Copyright (c) 2013, On Device Research Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.
diff --git a/urbanairship_demoapp/README.md b/urbanairship_demoapp/README.md
@@ -1,6 +1,13 @@
 ## trigger.io-ua-push demo app
 
 
+### dependencies
+
+The demo app depends on the following forge modules:
+ - logging
+ - package names
+
+
 TODO: add instructions to setup via Trigger-Toolkit.app
 
 ### manual setup
diff --git a/urbanairship_demoapp/src/config.json b/urbanairship_demoapp/src/config.json
@@ -9,10 +9,11 @@
 		"logging": {
 			"level": "DEBUG"
 		},
+
 		"contact": true,
 		"file": true,
 		"is": true,
-		"media": {},
+
 		"prefs": true,
 		"request": {
 			"permissions": [
@@ -22,16 +23,21 @@
 		},
 		"tools": true,
 		"reload": true,
+
+		"media": true,
+
 		"package_names": {
 			"ios": "com.ondeviceresearch.ondeviceresearch",
 			"android": "com.plugtester"
-		}
+		},
+		"is": true
 	},
 	"plugins": {
 		"urbanairship": {
 			"hash": "ed805d5b8b932d8c0879319aaa3a462e2a80ad17",
 			"type": "project"
 		}
 	},
-	"trusted_urls": []
+	"trusted_urls": [],
+	"uuid": "ef4904c2d9bf11e2a0e312313d00ecf3"
 }
diff --git a/urbanairship_demoapp/src/js/main.js b/urbanairship_demoapp/src/js/main.js
