Titanium

With the XtremePush module for Titanium you can add XtremePush to both iOS and Android apps built with Titanium.

Platform Specific Information

XtremePush supports push notifications for iOS devices via Apples's Push Notification Service (APNs for short). And push notifications for Android devices via Google’s GCM (Google Cloud Messaging for Android) service. This page contains Titanium specific instructions but It is also recommended you read the native documentation for these platforms. 

• iOS
• Android

This includes information on importing the SDKs, initialising the core integration and obtaining and uploading iOS and Android credentials for Push Notifications to the platform.

Advanced features include: tagging of events, custom push notification handling and location services can also be found in the SDKs section.

XtremePush Titanium SDK Setup

First, download the current Titanium module here. This zip file contains the module.

Next you must add the XtremePush Titanium module to your Titanium installation on your development machine if you have not already done so.

Mac OS X

If you are using Mac OS X copy the modules folder from the distribution zip file into the ~/Library/Application Support/Titanium folder and allow it to merge

Windows

If you are running Windows copy the modules folder from the distribution zip file into the C:\ProgramData\Titanium folder allow it to merge

Linux

If working on the Linux copy the modules folder from the distribution zip file into the ~/.titanium folder allow it to merge

Add Xtremepush to your Project in TitaniumStudio

When you have added the modules to your Titanium SDK installation you can use XtremePush in your project.

Modify the tiapp.xml

Import the XtremePush module into your project by double clicking your projects tiapp.xml in TitaniumStudio. You can add the module via the TiApp editor UI by clicking the green add button next to the list of modules,

and selecting XtremPush from the drop down list

you will see XtremePush in the list of modules if you have successfully added it.

You can also add the module by editing tiapp.xml via the raw xml editor

Note: For android apps, due to Xtremepush's dependency on play-services, you will also need to add the ti.playservices module, in the same way you added the Xtremepush module outlined above.

iOS

For details on how to connect your iOS app to the xtremepush platform and where to get the XTREME_PUSH_APP_KEY consult the iOS docs here.

You will need to add NSBluetoothPeripheralUsageDescription to the plist. It is a required usage description to have to add to your app if it includes CoreBluetooth (even if core bluetooth is not actively used). The xtremepush iOS SDK currently requires you to do that. See docs here for more information.

If you are adding adding location services make sure to include NSLocationWhenInUseUsageDescription to the plist, in iOS 8.0 and later this is required to Specify the reason for accessing the user’s location information.

 

If you are not using beacons then you don't have to do anything else. If you are using Beacons you will need to add a Bluetooth permission to you TiApp.xml file, like in the following:

<key>NSBluetoothAlwaysUsageDescription</key>
        <string>BlueTooth String</string>

Additionally you will need to add the bluetooth flag to your register.json in the iOS node, like in the following:

ios: {
         locationsEnabled: true,
         beaconsEnabled: true,       
      },

Android

The first thing we need is the Google-Services.json from the firebase console. 
Navigate to https://console.firebase.google.com/ 

Now navigate to the project settings.

Next step is to add your app to the Firebase project:

Now download the Google-services.json associated with that app


In native android, or another framework that uses the gradle build tool you can add a plugin which automatically migrates values from the google-services.json file to the app resources. On titanium this has to be done manually. 
In your project if you do not have a "values.xml" resource file, create one in the directory platform/android/res/values. 
The values we need to add to the XML are the following and can be found in the google-services.json file at the following place:
google_app_id:

{YOUR_CLIENT}/client_info/mobilesdk_app_id

gcm_defaultSenderId:

project_info/project_number

default_web_client_id:

{YOUR_CLIENT}/oauth_client/client_id (client_type == 3)

ga_trackingId:

{YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id

firebase_database_url:

project_info/firebase_url

google_api_key:

{YOUR_CLIENT}/api_key/current_key

google_crash_reporting_api_key:

{YOUR_CLIENT}/api_key/current_key

project_id:

project_info/project_id

In the end your your values.xml file will look something like the following:

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <! -- Present in all applications -->
    <string name="google_app_id" translatable="false">1:312123...:android:...</string>

    <! -- Present in applications with the appropriate services configured 
    <string name="gcm_defaultSenderId" translatable="false">312123...</string>
    <string name="default_web_client_id" translatable="false">312123...-860....apps.googleusercontent.com</string>
    <string name="google_api_key" translatable="false">AIza..</string>
    <string name="project_id" translatable="false">my_project...</string>
    ...

</resources>

Now you add the Xtremepush module and ti.playservices to your app:
​​

Now we edit the tiapp.xml file. Add the following to the android section:

 

Enable in Alloy Application

If you are using Alloy, then you would add the following to your alloy.js file:

You can see in the registration above there are three callback functions (messageResponseCallback, InboxBadgeCallback, deeplinkCallback). Examples of how to use these is shown later

In your controller JavaScript file (index.js) you would then need to register the app with the XtremePush servers as follows:

Because of Titanium's new handling of Windows and TabGroups as activities in Android, there are a number of additional options which can be set in your index.js file. Here is a full sample index.js. $.index is the app's main TabGroup and $.b1-14 are example buttons which show some of the options available in the module.

Build your app for iOS or Android and then send your first push using the appropriate instructions:

• Sending your first push notification
  • iOS
  • Android

 

Setting Notification Icon in Android

There is a key that can be set in the register json called setIcon. If set, the program will attempt to find and use iconfilenamewithoutextension.png in the *platform/android/res/drawable* folder in any notifications and will also search for a color entry with the same name in any of the XML files in the *platform/android/res/values* folder to use as a background colour behind the icon.

setIcon: "iconFileNameWithoutExtension",

Android introduced a new scheme with visual changes to notifications in Android 5.0 where you are encouraged to set an icon that is in keeping with their design guidelines. You can find some more information here.

 

Xtremepush Callback Functions

MessageResponseCallback, deeplinkCallback,  and inboxBadgeCallback are JavaScript functions defined in a JavaScript file of your project. After created you have to define them in the registerXtremePush function as example:

 

messageResponseCallback: messageResponseCallbackFunction,

      inboxBadgeCallback: inboxBadgeCallbackFunction,

      deeplinkCallback: onDeeplinkReceived,

 

They are called to be executed in special cases as explained below:

messageResponseCallback:

The response.type variable shown above can be either present | click | dismiss

• present - when a push notification is receved and the app is in the foreground
• click - when a message is clicked
• dismiss - when a message is dismissed

 

Below is a complete example of custom notification handling. It does multiple things:

• shows a custom dialog when a push message is received in foreground
• opens an article page when a message is clicked
• saves information when one of the message buttons is clicked

note: Every message sent in the campaigns associated with the example below, includes a payload key articleId

 

inboxBadgeCallback

happens when the badge number updates. The badge number is checked when:

• New push message arrives
• Application is started
• Inbox window is closed

An example is shown below

 

deeplinkCallback

happens when a message with the click action 'Go to deeplink' is clicked. 

An example is shown below:

 

Foreground Notification Handling

 

 

Retrieving your XtremePush ID

Now that your app is configured for mobile analytics and sending push notifications the final basic feature of XtremePush is retrieving your XtremePush ID. This can be accomplished by calling the deviceInfo method:

Alloy.Globals.xtremepush.deviceInfo

This method returns your device's id as obtained from XtremePush server. If your device has not received an id then it has not successfully registered and there is an issue with your integration. If for example you want to quickly output the the device id to the debug area in TitaniumStudio you would use it like this:

Ti.API.debug("deviceInfo" + Alloy.Globals.xtremepush.deviceInfo);

If you successfully retrieve the ID it can be used to identify your device on the platform and to send a push notification to just that device.

 

User Management

Set primary user on platform 

Alloy.Globals.xtremepush.setUser("");

Set temporary user on platform

Alloy.Globals.xtremepush.setTempUser("");