Appoxee Android SDK Integration

This document explains how to download the Appoxee Android SDK and integrate it with your application code. 

The integration process consists of the following steps:
 
  1. Download the Appoxee Android SDK - go to the Android SDK Downloads page and download the latest Appoxee Android SDK. The Archive file contains both Eclipse & Android Studio files.

  2. Add the Appoxee Android SDK to your project -  If using Android Studio , follow these Instructions . if Using Eclipse , extract the SDK Eclipse Zip file to Eclipse and create a new Android project that uses the extracted resources (see Adding the Appoxee Android SDK to Eclipse).

    Please note that Appoxee SDK 2.6.1 requires removing older Appoxee SDK versions, including manifest declarations, prior to full integration.

  3. Integrate Appoxee into your project - add the Appoxee Manifest Declarations to your AndroidManifest.xml (see Integrating Appoxee SDK in Project).

  4. Initialize Appoxee SDK to your Android Application Code - add the Appoxee SDK Code to your app's code (see Initialize Appoxee SDK to your Android Application Code)

  5. Customize your App's Push icon - to replace the default icon on the Android Push Notification panel with your own icon, proceed in either way:

    1. In your Eclipse project, go to "Appoxee resources/res/drawable" and replace "appoxee_default_icon.png" with your own icon file.
    2. In the application project, create a “drawable” resource named "appoxee_custom_icon.png". This resource will be used instead of the default icon file.

  6. Test your application - build and run your application on your device. Your debug console (LogCAT for Eclipse users) shows the device's logs, including your application logs.
    If you encounter any problems, send these logs to Appoxee Support (support@appoxee.com)

  7. Validate your SDK integration  - you can check the Appoxee SDK integration either via the Appoxee website or via the Appoxee API:
    1. Test a Push Notification - you can create a Push notification in one of the following ways:
      • Using the API - see Push Message API (if you have any questions, see the Android SDK Q&A).
      • Using the Appoxee website - log into your Appoxee account, go to the Apps tab, choose your Application Name, click Create Message (yellow button) and configure the new message.
    2. Test a Rich Message - If you enabled the Appoxee In-App inbox, test it by sending a message whose Content type is Push Notification + Rich Message (if you are using the Push Message API, set the message "content_type" argument to "3").
    3. Set your app's Push Rate - The Push Rate feature sets the number of Push Notifications sent per-second (p/s). This feature is intended for apps that have a server side, and it is used to prevent overloading the server with too many concurrent app opens (triggered by the Push Notification).
      To set the Push Rate, log into your Appoxee account, go to the Apps tab, choose your app to display its Application Information page, and then select the relevant Push Rate from the list. 
      The default rate is Normal (100 p/s), but you can choose different rates for different purposes. For example: When debugging the app, use a low rate: Debug speed (10 p/s). However, when sending a "Breaking News" Push Notification, set the rate to Fast (250 p/s).
    4. Create your first "Welcome" Message - if you are using the Push Message API, set the message "type" argument to "1".

Once you complete these steps, your Appoxee Android SDK integration is complete and you are ready to use Appoxee! (smile)

If you have any questions, please contact Appoxee Support (support@appoxee.com) with the log file extracted from Eclipse.