Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed the steps concerning the In-App Inbox, more apps & feedback (they are covered by the Appoxee Setup topic).
This document explains how to download the Appoxee Android SDK and integrate it with your application code.

...

  1. Enable Push Notifications for your application - follow the instructions in Android Application Setup

  2. Download the Appoxee Android SDK - go to the Android SDK Downloads page and download the latest Appoxee Android SDK.

  3. Add the Appoxee Android SDK as an Eclipse project - extract the SDK to Eclipse and create a new Android project that uses Appoxee resources (see Adding the Appoxee Android SDK to Eclipse).

  4. Integrate Appoxee into your code - add the Appoxee code to your Android application (see  Integration: Adding Appoxee 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 as follows:

    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.
    Customize the In-App Inbox (Appoxee Pro customers only) - Appoxee Pro accounts can change the Inbox design and customize its environment.
    To upgrade your installation to Appoxee Pro, please contact info@appoxee.com)
    1. .
  6. Enable additional Appoxee features (such as Feedback and More Apps):
    1. Log into your Appoxee account, go to the Apps tab and select your app to view its Application Information page.
    2. Go to the Settings section and check features and settings you wish to enable, for example:
      • Allow feedbacks - improve your application's star rating in the App Store, by allowing users to rate the app and communicate directly with the app owner. 
      • Allow more apps - cross-promote your apps from within the app itself: Show the user additional apps you released, so the user can easily install them. 
         

  7. Test your application - build and run your application on your device. Your debug console (LogCAT for Eclipse users) shows the test logs. 
     

  8. Validate your SDK integration - check the Appoxee SDK integration by taking the following steps:
    1. Test a Push Notification - to create a Push Notification using the API, see Push Message API (if you have any questions, see the Android Q&A section).
    2. Test a Rich Message - If you enabled the Appoxee In-App inbox, test it by sending message whose type is Push Notification + Rich Message (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 - set the message "type" argument to "1" (see Push Message API).

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

Note

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