This sample demonstrates how to integrate Localytics "App Analytics" in to a BlackBerry WebWorks application for BlackBerry 10.
Applies To
Author(s)
Dependencies
Icons
Contributing
- To contribute code to this repository you must be signed up as an official contributor.
####The following Cordova Plugins are required for this sample:####
com.blackberry.app
com.blackberry.ui.toast
Note: This sample is collecting live analytics data. To use this sample code in your own application, you must first register with Localytics and create your own application. A unique application key will be generated, and used to track analytics for your own app.
#####1. Register with Localytics#####
To begin tracking your own applications usage, you must Sign-up for Localytics. Once registered you will be able to create a new application and obtain your unique app "key" (used for tracking analytics). If you'd like to run this sample app using my test keys that's fine as well, just remember that in order to track your own analytics you'll need to register for an account.
#####2. Use your own key##### Your application key is used to identify your specific app on the Localytics server, so it knows which app is being tracked. If you are using this sample code for reference and did not replace my key for yours, you will not see any analytics data when you login to your Localytics dashboard.
To use your own key, edit the following code on line 31 of js/app.js.
localyticsSession = LocalyticsSession("<insert your key here>", options);
#####3. Tracking events and usage##### Localytics has done an amazing job at creating simple, easy to follow instructions for how to get started. Rather than duplicate their efforts I strongly recommend that you read their HTML5 Integration Guide.
-
Clone this repo to your local machine.
-
Ensure the BlackBerry 10 WebWorks SDK 2.0 is correctly installed.
-
Open a command prompt (windows) or terminal (mac) and run the following command:
webworks create <your source folder>\Analytics-Localytics -
Replace the default Analytics-Localytics\www folder with the \www folder from this project
-
Replace the default Analytics-Localytics\config.xml with the config.xml from this project
-
From the command prompt (Windows) or terminal (mac), navigate to the Analytics-Localytics folder
cd <your source folder>\Analytics-Localytics -
Run the following commands to configure plugins used by this app
webworks plugin add com.blackberry.app webworks plugin add com.blackberry.ui.toast -
Run the following command to build and deploy the app to a device connected via USB
webworks run
- BlackBerry HTML5 WebWorks - Downloads, Getting Started guides, samples, code signing keys.
- BlackBerry WebWorks Development Guides
- BlackBerry WebWorks Community Forums
- BlackBerry Open Source WebWorks Contributions Forums
Please see the README of the BB10-WebWorks-Samples repository for instructions on how to add new Samples or make modifications to existing Samples.
If you find a bug in a Sample, or have an enhancement request, simply file an Issue for the Sample.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.