![\"Urban](\"\/wp-content\/original-assets\/2017\/january\/getting-started-with-urban-airship-push-notifications\/urban-airship-logo-blue.png\"){kind=logo}
<\/p>\n<\/p>\n
Urban Airship<\/a> is a popular messaging and notification service. \u00a0In part 1 of this post we’ll look at how to set up Urban Airship push notifications. In part 2 of the post we\u2019ll use these notifications to<\/span> trigger replications in Couchbase Mobile<\/a>.<\/p>\n You can use Urban Airship (UA) for free. (See the UA web site for current pricing details.) You do have to register an account.<\/p>\n Bring up an existing Android or iOS project in your IDE (or create a new one). Here I’ll illustrate using Android.<\/p>\n Sign in to your UA account. Navigate to the New App page. Fill in your app name. Select the platforms you want to use. (We’ll pick Android and iOS for this example.) Hitting “Save” will take you to the quickstart quide. \u00a0(If you’ve already gone through the quickstart and need a refresher on the setup, you can find the steps for Android\u00a0here<\/a>\u00a0and for iOS here<\/a>.)<\/p>\n Here you’re offered a tab for each platform selected. As mentioned, we’ll focus on building for Android this time.<\/p>\n Follow the Urban Airship quickstart steps. I have a few tips for issues I encountered.<\/p>\n The UA guide refers to the project’s build.gradle script, but then shows modifying the module build.gradle script. I added the UA repository to my project’s gradle script, and the UA dependency to the module gradle script. That worked fine.<\/p>\n Look for the applicationID in the module gradle script.<\/p>\n To create your own Application class, right click in the app area of the Project navigation pane and pick New > Java Class. In the popup, set the class name. Then for the Superclass enter android.app.Application.<\/p>\n Don’t forget to update your manifest file. You can use the fully qualified name of your class, or the short form that UA shows. The fully qualified form looks like this:<\/p>\n UA uses Firebase Cloud Messaging (FCM). Step six has a link to further documentation by UA. This new page has detailed instructions on creating an API key for your app.<\/p>\n The instructions on that page under the heading ‘Configure FCM\/GCM Service with Urban Airship’ are a little out of date. You’ll find the area to enter your Api Key and Package at the end of the quickstart guide now, instead of where the docs say to look.<\/p>\n In one place, the UA docs refer to the “Google API Project Number”. This is what FCM calls your Sender ID.<\/p>\n The quickstart ends with a testing area, without much instruction. If you look back at the code included in your Application subclass, you’ll see it’s enabling user notifications. To test, build your app and install it on an emulator or device. (I tried both and they worked fine.)<\/p>\n Enter something into the text field and click “Send Test”. You should see an icon show up in the Android notification area. Oddly, this doesn’t include the text entered into the test area.<\/p>\n For troubleshooting UA directs you to an obscure “Error Console” link in the lower right corner of the documentation page. The link just brought me back to the quickstart guide, unfortunately.<\/p>\n As you saw in the preceding steps, setting up Urban Airship was pretty quick. The quickstart shows how to send an alert notification. To trigger data sync in a Couchbase Lite client, we’ll want to send a silent alert instead, part 2 of this post will cover that.<\/span><\/p>\n In part 1 of this post you setup Urban Airship, in part 2 I will show<\/span> a sample Android application built with Couchbase Lite<\/a> that uses an Urban Airship push notification to trigger synchronizing data from the cloud to a mobile device. Here “the cloud” will be a Sync Gateway<\/a> instance setup in a test configuration. (Couchbase Lite and Sync Gateway are both part of the Couchbase Mobile stack. You can read about Couchbase Mobile here<\/a>.)<\/p>\n Couchbase Mobile synchronizes data using unidirectional replications. You can set replications to run and end immediately once the local data is up-to-date (“one-shot”), or to listen indefinitely for new changes (“continuous”).<\/p>\n There are a few reasons you might want to use a service like Urban Airship to trigger synchronization instead of setting up a continous replication. For example, a continuous “pull” replication (one that retrieves data from the cloud) needs to keep a network connection open. An open connection will necessarily cause some amount of drain on the device battery, even while inactive. Ideally, an application would only open a connection when there exists changes to transfer.<\/p>\n Beyond that, push notification services like Urban Airship typically have a number of advanced features for addressing groups of devices. UA can give you great flexibility in managing when operations happen. Furthermore, if your app already uses a push service, that already requires its own open network connection. It makes sense to use that to trigger Couchbase Lite instead of doubling up the networking.<\/p>\n This example will show how to integrate Urban Airship. I’ll walk through all the necessary pieces, so you can build a fully working application.<\/p>\n Here’s a look at the application in action. The upper part of the image shows the app running. The lower part shows a push notification sent from the command line. When the app receives the push notification, it puts up a progress spinner, fires off a one-shot pull replication, then displays the document changes received in a text view.<\/p>\n To use Urban Airship (UA), we need to implement two classes, a subclass of Autopilot, and a subclass of AirshipReceiver.<\/p>\n UA has to be initialized before use. You can do that in two ways, either call The class is simple. I don’t want to display anything in the notification bar. I use this class to turn off user notifications, and that’s all.<\/p>\n Here’s the full listing of CBAutoPilot.java.<\/p>\n To use this class, UA employs a technique unique to Android. You indicate which class to use with an entry in your Android manifest file. For my case, the entry looks like this (placed inside the This is where a bit of Android magic happens. UA includes a Content Provider class to automate the initilization. Content Providers are guaranteed to get instantiated before the application’s With UA initialized and ready to go, we need to provide the hooks to capture and process notifications. To do that, implement a subclass of AirshipReceiver. Again, the class is straightforward.<\/p>\n Here’s the full listing of CBAirshipReceiver.java.<\/p>\n When we get to testing the app, we’ll see how UA lets you set the alert text. I used that here provide a few different remote operations. An alert can start and stop replications. I also included the ability, by sending “reset”, to delete the database. I did that because once you replicate the data, it’s persistent on the device. Shutting down the app doesn’t reset the local database. Rather than always having to add new documents through Sync Gateway to show replication working, I added the ability to wipe the device database and start over.<\/p>\n You’ll notice a few other overridden methods above. Those methods are all declared abstract in the AirshipReceiver class, so we have to include at least a minimal implementation. It turns out, though, that we need to know the device channel ID to send it a message. This channel ID changes often. In a future post, I’ll show how I register the ID so a server-side application can send to the device. For now, it’s useful to log the ID so we can extract it and use it in testing.<\/p>\n The hooks above get UA up and running, trap notifications, and trigger actions based on their contents. Now let’s take a look at the application itself.<\/p>\n The app consists of one Activity set up so we can see the contents of documents as they get pulled. The other class wraps some of the Couchbase Lite functionality in a helper.<\/p>\n In the main activity, I want to show a progress bar while replications happen, then display the set of documents sent.<\/p>\n Here’s the full listing of MainActivity.java<\/p>\n The core of the code here consists of the two change listeners, one for the database, and one for replications. Each listener interface defines a single method The Document changes listener lets us track the actual document updates. A replication may change more than one document at a time. The change event returns a list of document IDs. Looping over the document IDs, we retrieve each document directly, translate the JSON contents into a string, and append it to the text to display. The change listeners are called on a background thread. To finish out, we need to manipulate the UI elements on the main thread. This is easily done with the The other listener allows us to display a busy-wait spinner (indefinite progress bar) depending on the Replication state. You can read more about monitoring replication state here<\/a>.<\/p>\n I often wrap database functions in a helper class. Since we only need one instance of the helper, I use a singleton pattern. Just like UA, I want the helper available before the main application starts. I use the same technique of putting the code in a Content Provider.<\/p>\n Here’s the full listing of CBLHelper.java.<\/p>\n You can see this class just forms a thin wrapper. We retain an instance of the class during A content provider has several mandatory methods to implement. We need to provide stubs for those, which you see in the last five methods.<\/p>\n Finally, just to show how this ties together and the various parts get exposed, I’ve included the Android manifest file for the project.<\/p>\n Here’s the complete listing of AndroidManifest.xml.<\/p>\n The UA library comes with its own manifest file. The Android build system integrates all the different manifest files to create the final one. The UA library manifest file is where you’ll find the entries for the Content Provider that bootstraps the library.<\/p>\n To try the app out, I used Sync Gateway with the built-in walrus database. Walrus is an in-memory database<\/a> usually used just for testing. This saves the trouble of setting up a back-end Couchbase Server instance.<\/p>\n Here’s the complete listing of the Sync Gateway configuration file.<\/p>\n This tells Sync Gateway to listen only on the You might have noticed we use 10.0.2.2 as the IP address for Sync Gateway in the Android app. The standard emulator that comes with Android Studio maps this automatically to the hosting machine’s If you want to learn more about setting up Sync Gateway on your development machine, or how to work with it from the command line, take a look at this blog series<\/a>.<\/p>\n To test everything and record the animation shown at the beginning of the blog, I run both the Android emulator and Sync Gateway on one machine. I then post push notifications to UA through their REST API.<\/p>\n To get something interesting prepared, I first add a document to Sync Gateway. Here’s a shell command to do that.<\/p>\n (Read more about this here<\/a>).<\/p>\n With a new document in the database on Sync Gateway, and the app up and running, all that’s left is to trigger a pull replication to see the action.<\/p>\n Here’s the You’ll need to provide your own application key and application master secret above. You also need to look at the log files to see the channel value to enter for “android_channel”. That changes fairly regularly. Unfortunately UA doesn’t do much to indicate this. If you find push notifications don’t seem to be having any effect, check the channel value.<\/p>\n After posting to UA, you should see a response like this.<\/p>\n And, finally, to reset to a blank database to try again, you can post this.<\/p>\n That’s it for getting our Android app prepared to perform replications based on push notifications. Be sure and check out this post<\/a> on monitoring the Sync Gateway changes feed.<\/p>\n Download Couchbase and Sync Gateway here<\/a>. See our documentation<\/a> for how to add Couchbase Lite to a project.<\/p>\n Check out more resources on our developer portal<\/a> and follow us on Twitter @CouchbaseDev<\/a>.<\/p>\n You can post questions on our forums<\/a>. And we actively participate on Stack Overflow<\/a>.<\/p>\nWhat you’ll need<\/h2>\n
\n
Part 1 – Setting up Urban Airship<\/h2>\n
![\"Urban](\"\/wp-content\/original-assets\/2017\/january\/getting-started-with-urban-airship-push-notifications\/urban-airship---new-app.png\")
<\/p>\nUA quickstart<\/h3>\n
Steps 1 & 2 of Urban Airship quickstart<\/h4>\n
Step 5 of Urban Airship quickstart<\/h4>\n
![\"Creating](\"\/wp-content\/original-assets\/2017\/january\/getting-started-with-urban-airship-push-notifications\/screen-shot-2017-01-28-at-3.37.30-pm.png\")
<\/p>\n <application\r\n android:name=\"com.couchbase.cblite.android.cbpushsync.MyApplication\"<\/pre>\n
Step 6 of Urban Airship quickstart<\/h4>\n
Testing<\/h2>\n
![\"Urban](\"\/wp-content\/original-assets\/2017\/january\/getting-started-with-urban-airship-push-notifications\/screen-shot-2017-01-28-at-4.15.18-pm.png\")
<\/p>\nWrapping up part 1<\/h2>\n
Part 2 – Triggering Data Synchronization from the Cloud<\/h2>\n
Background<\/h2>\n
The Application<\/h2>\n
![\"\"](\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2017\/04\/CBPushSync.gif\")
To understand this example, we’ll take a look at four classes, some of the “glue” that brings them together, and show how to test the results.<\/p>\nClasses Required by Urban Airship<\/h2>\n
Autopilot<\/h3>\n
takeOff<\/code> in the application\u2019s onCreate<\/code> method or by creating a subclass of Autopilot. I chose to do the latter. As we’ll see, UA has an interesting way of automatically using our subclass.<\/p>\npackage com.couchbase.cblite.android.cbpushsync;\r\n\r\nimport com.urbanairship.Autopilot;\r\nimport com.urbanairship.UAirship;\r\n\r\npublic class CBAutoPilot extends Autopilot {\r\n @Override\r\n public void onAirshipReady(UAirship airship) {\r\n airship.getPushManager().setUserNotificationsEnabled(false);\r\n }\r\n}<\/pre>\napplication<\/code> section):<\/p>\n <meta-data android:name=\"com.urbanairship.autopilot\"\r\n android:value=\"com.couchbase.cblite.android.cbpushsync.CBAutoPilot\"\/>\r\n<\/pre>\n
onCreate<\/code> method gets called. UA uses that to include code to read this meta-data entry, instantiate the subclass, and call the onAirshipReady<\/code> method.<\/p>\nAirshipReceiver<\/h3>\n
package com.couchbase.cblite.android.cbpushsync;\r\n\r\nimport android.content.Context;\r\nimport android.support.annotation.NonNull;\r\nimport android.util.Log;\r\n\r\nimport com.urbanairship.AirshipReceiver;\r\nimport com.urbanairship.push.PushMessage;\r\n\r\npublic class CBAirshipReceiver extends AirshipReceiver {\r\n private static final String TAG = \"CBAirshipReceiver\";\r\n\r\n @Override\r\n protected void onPushReceived(Context context, PushMessage message, boolean notificationPosted) {\r\n Log.i(TAG, \"Received push message. Alert: \" + message.getAlert() + \". posted notification: \" + notificationPosted);\r\n\r\n switch(message.getAlert()) {\r\n case \"start\":\r\n CBLHelper.getInstance().startReplication();\r\n break;\r\n case \"stop\":\r\n CBLHelper.getInstance().stopReplication();\r\n break;\r\n case \"reset\":\r\n CBLHelper.getInstance().reset();\r\n break;\r\n default:\r\n break;\r\n }\r\n }\r\n\r\n @Override\r\n protected void onChannelCreated(@NonNull Context context, @NonNull String channelId) {\r\n Log.i(TAG, \"Channel created. Channel Id:\" + channelId + \".\");\r\n }\r\n\r\n @Override\r\n protected void onChannelUpdated(@NonNull Context context, @NonNull String channelId) {\r\n Log.i(TAG, \"Channel updated. Channel Id:\" + channelId + \".\");\r\n }\r\n\r\n @Override\r\n protected void onChannelRegistrationFailed(Context context) {\r\n Log.i(TAG, \"Channel registration failed.\");\r\n }\r\n}\r\n<\/pre>\nThe Application Classes<\/h2>\n
The Main Activity<\/h3>\n
package com.couchbase.cblite.android.cbpushsync;\r\n\r\nimport android.os.Bundle;\r\nimport android.support.v7.app.AppCompatActivity;\r\nimport android.support.v7.widget.Toolbar;\r\nimport android.util.Log;\r\nimport android.view.View;\r\nimport android.widget.ProgressBar;\r\nimport android.widget.TextView;\r\n\r\nimport com.couchbase.lite.Database;\r\nimport com.couchbase.lite.Document;\r\nimport com.couchbase.lite.DocumentChange;\r\nimport com.couchbase.lite.replicator.Replication;\r\nimport com.couchbase.lite.replicator.ReplicationState;\r\nimport com.fasterxml.jackson.databind.ObjectMapper;\r\n\r\nimport java.io.IOException;\r\n\r\npublic class MainActivity extends AppCompatActivity {\r\n private static String TAG = MainActivity.class.getSimpleName();\r\n private static final ObjectMapper mapper = new ObjectMapper();\r\n\r\n private CBLHelper cblHelper = CBLHelper.getInstance();\r\n private TextView documentView;\r\n private ProgressBar progressBar;\r\n\r\n @Override\r\n protected void onCreate(Bundle savedInstanceState) {\r\n super.onCreate(savedInstanceState);\r\n setContentView(R.layout.activity_main);\r\n Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);\r\n setSupportActionBar(toolbar);\r\n\r\n documentView = (TextView) findViewById(R.id.documentView);\r\n progressBar = (ProgressBar) findViewById(R.id.progressBar);\r\n\r\n cblHelper.initialize(\r\n new Database.ChangeListener() {\r\n @Override\r\n public void changed(Database.ChangeEvent event) {\r\n Log.i(TAG, \"Database change called: count - \" + event.getChanges().size());\r\n\r\n if (!event.isExternal()) {\r\n return;\r\n }\r\n\r\n String json = \"\";\r\n\r\n for (final DocumentChange change : event.getChanges()) {\r\n if (!change.isCurrentRevision()) {\r\n continue;\r\n }\r\n\r\n Document changedDoc = cblHelper.getExistingDocument(change.getDocumentId());\r\n\r\n if (changedDoc == null) continue;\r\n\r\n try {\r\n json += mapper.writeValueAsString(changedDoc.getProperties());\r\n } catch (IOException e) {\r\n e.printStackTrace();\r\n }\r\n }\r\n\r\n final String text = json;\r\n\r\n runOnUiThread(new Runnable() {\r\n @Override\r\n public void run() {\r\n documentView.setText(text);\r\n }\r\n });\r\n }\r\n },\r\n new Replication.ChangeListener() {\r\n @Override\r\n public void changed(Replication.ChangeEvent event) {\r\n Log.i(TAG, \"Replication change called: \" + event.toString());\r\n\r\n if (event.getError() != null) return;\r\n\r\n if (event.getTransition() == null) return;\r\n\r\n ReplicationState dest = event.getTransition().getDestination();\r\n\r\n final int replicationProgress =\r\n ((dest == ReplicationState.STOPPING ||\r\n dest == ReplicationState.STOPPED) ?\r\n View.INVISIBLE : View.VISIBLE);\r\n\r\n runOnUiThread(new Runnable() {\r\n @Override\r\n public void run() {\r\n progressBar.setVisibility(replicationProgress);\r\n }\r\n });\r\n }\r\n }\r\n );\r\n }\r\n}<\/pre>\nchanged<\/code>.<\/p>\nrunOnUiThread<\/code> method of the Activity.<\/p>\nThe Database Helper Class<\/h3>\n
package com.couchbase.cblite.android.cbpushsync;\r\n\r\nimport android.content.ContentProvider;\r\nimport android.content.ContentValues;\r\nimport android.database.Cursor;\r\nimport android.net.Uri;\r\nimport android.os.Handler;\r\nimport android.os.Looper;\r\nimport android.support.annotation.NonNull;\r\nimport android.support.annotation.Nullable;\r\nimport android.util.Log;\r\n\r\nimport com.couchbase.lite.CouchbaseLiteException;\r\nimport com.couchbase.lite.Database;\r\nimport com.couchbase.lite.Document;\r\nimport com.couchbase.lite.Manager;\r\nimport com.couchbase.lite.android.AndroidContext;\r\nimport com.couchbase.lite.replicator.Replication;\r\n\r\nimport java.io.IOException;\r\nimport java.net.URL;\r\n\r\npublic class CBLHelper extends ContentProvider {\r\n public static final String TAG = \"Push Sync\";\r\n\r\n private static String DB = \"db\";\r\n \/\/private static String syncGateway = \"https:\/\/localhost:4984\";\r\n private static String syncGateway = \"https:\/\/10.0.2.2:4984\";\r\n private static URL syncGatewayURL;\r\n\r\n private Manager manager;\r\n private Database database;\r\n private Replication puller;\r\n\r\n private Database.ChangeListener databaseChangeListener;\r\n private Replication.ChangeListener replicationChangeListener;\r\n\r\n private static CBLHelper instance;\r\n\r\n public static CBLHelper getInstance() { return instance; }\r\n\r\n @Override\r\n public boolean onCreate() {\r\n instance = this;\r\n\r\n enableLogging();\r\n\r\n try {\r\n syncGatewayURL = new URL(syncGateway + \"\/\" + DB);\r\n manager = new Manager(new AndroidContext(getContext()), Manager.DEFAULT_OPTIONS);\r\n } catch (IOException ex) {\r\n ex.printStackTrace();\r\n }\r\n\r\n return true;\r\n }\r\n\r\n public void closeDatabase() {\r\n database.close();\r\n }\r\n\r\n public void startReplication() {\r\n puller.start();\r\n }\r\n\r\n public void stopReplication() { puller.stop(); }\r\n\r\n public void reset() {\r\n stopReplication();\r\n\r\n try {\r\n database.delete();\r\n } catch (CouchbaseLiteException ex) {\r\n ex.printStackTrace();\r\n }\r\n\r\n initialize(databaseChangeListener, replicationChangeListener);\r\n }\r\n\r\n public void initialize(Database.ChangeListener dbl, Replication.ChangeListener rl) {\r\n try {\r\n database = manager.getDatabase(DB);\r\n } catch (CouchbaseLiteException ex) {\r\n ex.printStackTrace();\r\n }\r\n\r\n database.addChangeListener(dbl);\r\n databaseChangeListener = dbl;\r\n\r\n puller = database.createPullReplication(syncGatewayURL);\r\n puller.addChangeListener(rl);\r\n replicationChangeListener = rl;\r\n }\r\n\r\n public Document getExistingDocument(String documentID) {\r\n return database.getExistingDocument(documentID);\r\n }\r\n\r\n \/\/ Logging\r\n\r\n private void enableLogging() {\r\n Manager.enableLogging(TAG, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG_SYNC_ASYNC_TASK, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG_SYNC, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG_QUERY, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG_VIEW, Log.VERBOSE);\r\n Manager.enableLogging(com.couchbase.lite.util.Log.TAG_DATABASE, Log.VERBOSE);\r\n }\r\n\r\n \/\/ Helper function to dispatch on UI thread\r\n private void runOnUiThread(Runnable runnable) {\r\n new Handler(Looper.getMainLooper()).post(runnable);\r\n }\r\n\r\n \/\/ Required overrides\r\n\r\n @Nullable\r\n @Override\r\n public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {\r\n return null;\r\n }\r\n\r\n @Nullable\r\n @Override\r\n public String getType(@NonNull Uri uri) {\r\n return null;\r\n }\r\n\r\n @Nullable\r\n @Override\r\n public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {\r\n return null;\r\n }\r\n\r\n @Override\r\n public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {\r\n return 0;\r\n }\r\n\r\n @Override\r\n public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {\r\n return 0;\r\n }\r\n}\r\n<\/pre>\nonCreate<\/code> which becomes our singleton. Some other basic setup happens, like enabling logging and creating a database manager. I wrote an initialize<\/code> method used to actually open the database, prepare the pull replication, and attach the two change listeners. Recall this is called from our Activity class. (Note: You can have more than one change listener for each type. Couchbase keeps a list of all added listeners, not just the latest one.) The other database methods just provide simple shortcuts.<\/p>\nThe Android Manifest<\/h2>\n
<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<manifest xmlns:android=\"https:\/\/schemas.android.com\/apk\/res\/android\"\r\n package=\"com.couchbase.cblite.android.cbpushsync\">\r\n\r\n <application\r\n android:allowBackup=\"true\"\r\n android:icon=\"@mipmap\/ic_launcher\"\r\n android:label=\"@string\/app_name\"\r\n android:supportsRtl=\"true\"\r\n android:theme=\"@style\/AppTheme\">\r\n <meta-data android:name=\"com.urbanairship.autopilot\"\r\n android:value=\"com.couchbase.cblite.android.cbpushsync.CBAutoPilot\"\/>\r\n <activity\r\n android:name=\".MainActivity\"\r\n android:label=\"@string\/app_name\"\r\n android:theme=\"@style\/AppTheme.NoActionBar\">\r\n <intent-filter>\r\n <action android:name=\"android.intent.action.MAIN\" \/>\r\n\r\n <category android:name=\"android.intent.category.LAUNCHER\" \/>\r\n <\/intent-filter>\r\n <\/activity>\r\n <receiver android:name=\".CBAirshipReceiver\"\r\n android:exported=\"false\">\r\n\r\n <intent-filter>\r\n <action android:name=\"com.urbanairship.push.CHANNEL_UPDATED\" \/>\r\n <action android:name=\"com.urbanairship.push.OPENED\" \/>\r\n <action android:name=\"com.urbanairship.push.RECEIVED\" \/>\r\n <action android:name=\"com.urbanairship.push.DISMISSED\" \/>\r\n\r\n <category android:name=\"${applicationId}\" \/>\r\n <\/intent-filter>\r\n <\/receiver>\r\n <provider\r\n android:authorities=\"${applicationId}.dbhelper\"\r\n android:exported=\"false\"\r\n android:enabled=\"true\"\r\n android:name=\".CBLHelper\" \/>\r\n <\/application>\r\n\r\n<\/manifest><\/pre>\nSync Gateway<\/h2>\n
{\r\n \"log\": [\"HTTP+\"],\r\n \"adminInterface\": \"127.0.0.1:4985\",\r\n \"interface\": \"127.0.0.1:4984\",\r\n \"CORS\": {\r\n \"origin\":[\"*\"],\r\n \"loginorigin\":[\"*\"],\r\n \"headers\":[\"Content-Type\"],\r\n \"maxAge\": 1728000\r\n },\r\n \"databases\": {\r\n \"db\": {\r\n \"server\": \"walrus:\",\r\n \"users\": { \"GUEST\": {\"disabled\": false, \"admin_channels\": [\"*\"] } }\r\n }\r\n }\r\n}<\/pre>\nlocalhost<\/code> interface, accept any cross origin requests, and enables the special GUEST with access to all channels. It’s a pretty good general purpose configuration to start with to make sure everything’s working.<\/p>\nlocalhost<\/code>. If you use a different emulator (Genymotion is another popular one), be sure to look up what IP address to use, since they differ.<\/p>\nTesting<\/h2>\n
$ curl -X PUT -H 'Content-Type: application\/json' -H 'Accept: application\/json' -d '{ \"test\" : \"UA\", \"channels\": \"public\" }' https:\/\/localhost:4984\/db\/doc\r\n<\/pre>\ncurl<\/code> command to send a “start” signal. Recall I pull the value from the “alert” part of the notification to trigger actions.<\/p>\n$ curl https:\/\/go.urbanairship.com\/api\/push -u 'appKey:appMasterSecret' -X POST -H 'Content-Type: application\/json' -H 'Accept: application\/vnd.urbanairship+json; version=3;' -d '{ \"audience\": { \"android_channel\": \"3110bc81-1c7b-4ef8-a7a3-7c56aab19f08\" }, \"notification\" : { \"alert\": \"start\" }, \"device_types\": \"all\" }'<\/pre>\n{\"ok\":true,\"operation_id\":\"2a6c0edf-e5d0-4b4d-b762-ad5c4478c291\",\"push_ids\":[\"1951019a-2b7f-4f1b-8888-e87047a1feec\"],\"message_ids\":[],\"content_urls\":[]}<\/pre>\n$ curl https:\/\/go.urbanairship.com\/api\/push -u 'appKey:appMasterSecret' -X POST -H 'Content-Type: application\/json' -H 'Accept: application\/vnd.urbanairship+json; version=3;' -d '{ \"audience\": { \"android_channel\": \"3110bc81-1c7b-4ef8-a7a3-7c56aab19f08\" }, \"notification\" : { \"alert\": \"reset\" }, \"device_types\": \"all\" }'\r\n<\/pre>\nConclusion<\/h2>\n
Postscript<\/h2>\n