OpenBack Titanium Mobile Module
To install OpenBack for your Titanium app, download the latest release binaries from Github then unzip in your application folder.
Adding the module
tiapp.xml, add the OpenBack module for android and/or iOS
iOS Specific Settings
Edit the plist section of your
tiapp.xml - most settings are optional.
For a full list of available plist settings, check iOS PList documentation.
There seems to be a bug with the appcelerator build tools when settting an integer value to 0 like
<integer>0</integer>, the tool transforms it into
<integer/> which is invalid with xcode.
Android Specific Settings
Add a file named
openback.json to the
app/assets/android folder. After the build, it should appear in the
assets/Resources folder in your build folder.
Refer to the config file for details.
Firebase is also required for some features (instant message update, regular push messages). We recommend using this repo. Once you have Firebase setup, make sure to add the OpenBack services to handle messages in
Include this line in your application source file(s) to to load the module.
If your application needs COPPA to be enabled, set the COPPA compliant status with this function. If COPPA is enabled, messages will not run unless compliant is set to true.
When your user requests that all the data should be erased, set this value to true. It will inform the OpenBack server to remove all logs for the current user. All future logs will be erased after processing. If you wish to be fully GDPR complient, you also need to enable GDPR in your application settings on the OpenBack Dashboard.
Returns the current OpenBack SDK version.
Logging a Goal
At any point, you can log a goal that is associated with a message. Make sure to use the Goal code, not the Goal name.
User Info & Custom Values
Set a custom trigger value. Value can be
For the trigger index, use CUSTOM_TRIGGER_1 to CUSTOM_TRIGGER_10.
The application can pass some extra user information using a simple dictionary object by setting the following fields:
|string||Address line 1|
|string||Address line 2|
|string||Advertising identifier set by the application|
|string||ISO-2 country code|
|string||Date of birth YYYY-MM-DD|
|string||Opting in for message updates "true"/"false"|
|string||Phone Number (international format)|
|string||Custom user identifier 1|
|string||Custom user identifier 2|
|string||Custom user identifier 3|
|string||Custom user identifier 4|
|string||Custom user identifier 5|
Note on Custom User Identifiers
Identity is for use with the OpenBack API. If you are not an OpenBack API client, don't use them. Identities are bound to the current OpenBack user, so changing any one of them will reset user and campaign usage. A usage example: when your application has users that can login and logout, you can set one of the Identity to a token used in your system to identify that user. Later on, using the OpenBack API, you can fetch details from that user.
It is also possible to use Hyperloop to call the SDK directly.
Pros: Use Cocoapods and maven to stay up-to-date with SDKs.
Cons: The native API differs enough that you will need a lot of
if ANDROID cases.
Please refer to the iOS API for more info.
Please refer to the android API for more info.