Pre-BlackBerry 10 integration

Integrate your Pre-BlackBerry 10 app with Localytics by following these instructions.

1. In your Localytics Dashboard, create a new application and copy the application key.
2. Download our Localytics BlackBerry SDK.
3. Add the source code to an existing project by copying the Localytics’ com folder into your project’s src folder, such that the Localytics libraries are located at <project>\src\com\Localytics\LocalyticsSession.
4. Import the library by adding the following code to the top of your main activity.

   import com.Localytics.LocalyticsSession.*;

5. Create the object by adding the following code to your application class, or the class that calls .enterEventDispatcher().
   Maintain the LocalyticsSession object in your Application’s class, so that it can easily be accessed from any screen in your application.

   private final static String APPLICATION_KEY = "APP_KEY"; 
                   private LocalyticsSession _session = new LocalyticsSession(APPLICATION_KEY);

6. Add an accessor function to your main application class so this object may be accessed from anywhere in your code.

   public LocalyticsSession getLocalyticsSession().
   {
   return this._session;
   }

7. Open the session and begin uploading.
   Uploading should happen at the beginning of the app because this shows the ‘would you like to allow access to analytics.localytics.com’ dialog which the user will see before they have a chance to begin an activity. This also provides the uploader the maximum amount of time to complete if the wireless network is slow. This is best done in the constructor of your application.

   LocalyticsSkeletonApp()
   {
   // open the session and begin uploading.
   _session.open();
   _session.upload();
   pushScreen(new LocalyticsSkeletonAppScreen());
   }

8. Finally, for every exit path in your application, you must close the session. Regardless of the method you choose, remember to overload any onClose() methods which could lead to an exit.

   • If you exit from within a screen, do this by calling the accessor created in step 7.

     ((appClassName)UiApplication.getUiApplication()).getLocalyticsSession().close();

   • However, we recommend you maintain a single exit point inside the application class which gets called anywhere the app terminates.

     public void exit()
     {
     this._session.close();
     System.exit(0);
     }

9. Test your app. Launch the simulator (or even better, compile, sign, and run on a real device), let the data upload, and view it on the webservice to make sure it is there.
   Remember that the upload only happens when the session is started so any events you tag will not get seen until you upload data a second time.
   The uploader code assumes the simulator will be able to make a connection with deviceSide=true; set. If you are testing in an MDS-only environment, simply change USE_MDS_IN_SIMULATOR to true in UploaderThread.java. This variable has no impact on how the library behaves on an actual device.