Introduction

This document explains how to add the Appoxee code to your application code (step 3 of the Appoxee Android SDK integration process).

...

If you choose to use Google Play Services, you need to know the following :

...

To test your app when using the Google Play services SDK, you must use either:

• A compatible Android device that runs Android 2.3 or higher and includes Google Play Store.
• The Android emulator with an AVD that runs the Google APIs platform based on Android 4.2.2 or higher.

...

To make the Google Play services APIs available to your app:

1. Copy the library project at <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/ to the location where you maintain your Android app projects.
2. Import the library project into your Eclipse workspace (if you use Eclipse) : Click File > Import, select Android > Existing Android Code into Workspace, and browse to the copy of the library project to import it.
3. In your app project, reference Google Play services library project.

   Note: You should be referencing a copy of the library that you copied to your development workspace—you should not reference the library directly from the Android SDK directory.

4. Use the AndroidManifest.xml written below for GooglePlayServices integration

...

-keep class * extends java.util.ListResourceBundle {
    protected Object[][] getContents();
}

-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
    public static final *** NULL;
}

-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
    @com.google.android.gms.common.annotation.KeepName *;
}

-keepnames class * implements android.os.Parcelable {
    public static final ** CREATOR;
}

We now have 2 options of Integration : Explicit & Implicit.

Explicit integration enables (through inheritance and interface implementation) an automated process of sending analytics data to Appoxee and to control API Calls (Tags, Alias etc.) through an Observer (Callback Methods implementation in your code which are declared in AppoxeeObserver) that will indicate if the SDK is done loading and ready to process the API Calls. This will save the trouble of checking if the SDK is ready through a separate thread or any other means.

Explicit Integration is the preferred way.

Implicit Integration is a form of Integration that can be done if your code doesn't allow you to inherit from Appoxee and to implement it's Observer Interface. Both Integrations are explained below.

The code sections below use the following typographic conventions:

• Regular text - existing code: You should already have this code in your project by default. No changes are required.
• Bold text - new code: Make sure you add this Appoxee code to your app code.
• Green text - comments: A comment describes the code that follows it and notes special issues you should pay attention to. Please read the comments carefully.
• Blue text - AndroidManifest.xml updates: The changes you should make in the app's AndroidManifest.xml file.

Integration Instructions

The integration has two parts:

1. Source code integration - Integration into the source code which can be done in two ways:
   1. Explicit - Explicit integration enables (through inheritance and interface implementation) an automated process of sending analytics data to Appoxee and to control API Calls (Tags, Alias etc.) through an Observer (Callback Methods implementation in your code which are declared in AppoxeeObserver)  that will indicate if the SDK is done loading and ready to process the API Calls. This will save the trouble of checking if the SDK is ready through a separate thread or any other means. Explicit Integration is the preferred way.
   2. Implicit - Implicit Integration is a form of Integration that can be done if your code doesn't allow you to inherit from Appoxee and to implement it's Observer Interface. Both Integrations are explained below.
2. Manifest Integration and Advanced Options (Inbox / DeepLink (URLScheme) ) - Needed in either case of Code Integration (Explicit/Implicit)

...

Eclipse Users : When compiling a production APK file with ProGuard and Appoxee , enter the following lines into the file "proguard-project.txt"

-dontwarn
# OrmLite uses reflection
-keep class com.j256.**
-keepclassmembers class com.j256.** { *; }
-keep enum com.j256.**
-keepclassmembers enum com.j256.** { *; }
-keep interface com.j256.**
-keepclassmembers interface com.j256.** { *; }
-keepattributes Signature
-keepattributes *Annotation*
-keepclassmembers class * { public <init>(android.content.Context); }

In order to avoid these additions in each activity, you can simply extend AppoxeeBaseActivity instead of Activity. (AppoxeeBaseActivity extends Android’s FragmentActivity and contains the onStart() & onStop() calls)

Source code integration

Option A: Explicit Integration (with Observer) : 

...

...
new initAsync(getApplicationContext(),"APP_KEY",
                     "SECRET_KEY", "com.package.MainActivity" , true, this).execute();
AppoxeeManager.setDebug(true);
Appoxee.parseExtraFields(getIntent().getExtras());
setContentView(R.layout.main);
...

Make sure that the following methods are implemented and contain Appoxee's method calls :

    @Override
    protected void onResume()
    {
     super.onResume();
     // If Inbox implemented and you have a method for updating your inbox's 
     // Badge
     updateMsgBadge();
    }


 @Override
 public void onRegistrationCompleted() {
  // TODO Auto-generated method stub
     Utils.Debug("Can perform all API Calls");
 }


 @Override
 public void onMessagesUpdateCompleted() 
 {
 // If Inbox implemented and you have a method for updating your inbox's 
 // Badge
    Utils.Debug("Can update Badge");
    updateMsgBadge();
 }

@Override 
protected void onStart()
{
   super.onStart();
   Appoxee.onStart();
}
    
@Override
protected void onStop()
{
   super.onStop();
   Appoxee.onStop();
}

Option B: Implicit Integration (without using Observer)

...

In your main activity class onCreate() method enter the following code :

...
new initAsync(getApplicationContext(),"APP_KEY",
                     "SECRET_KEY", true, "com.package.MainActivity").execute();
AppoxeeManager.setDebug(true);
Appoxee.parseExtraFields(getIntent().getExtras());
setContentView(R.layout.main);
...

@Override  
protected void onStart() 
{
   super.onStart();
   Appoxee.onStart();
}

@Override
protected void onStop()
{
   super.onStop();
   Appoxee.onStop();
}

@Override       
protected void onNewIntent(Intent intent) 
{
   super.onNewIntent(intent);
   Bundle bundle = intent.getExtras();
   Appoxee.parseExtraFields(bundle);
}

@Override 
protected void onResume()
{
  super.onResume();
  // If Inbox implemented and you have a method for updating your inbox's 
  // Badge
  updateMsgBadge();
}

...

When Integrating Appoxee and choosing not to use an Observer, All Appoxee API Calls will fail unless implementing a thread that will sample the flag

Appoxee.isReady()==true. Only then will the API Calls will execute (Tags,Alias... )

@Override 
protected void onStart()
  {
   super.onStart();
   Appoxee.onStart();
  }
    
@Override
protected void onStop()
  {
   super.onStop();
   Appoxee.onStop();
  }

Manifest Integration and Advanced Options (Inbox / DeepLink (URLScheme) ) :

...

If prompted with an error, add this "Import" command to enable Appoxee SDK usage:

import com.appoxee.Appoxee; 

AndroidManifest.xml Updates - Make the following changes to your app's AndroidManifest.xml file:

GCM requires Android 2.2 or later. If your app cannot work without GCM, add the following line, where "xx" is the latest target SDK version:

<uses-sdk android:minSdkVersion="8" android:targetSdkVersion="xx" />  

Declare and use a custom permission, so only this application can receive GCM messages:

<permission android:name="com.appoxee.example.permission.C2D_MESSAGE" android:protectionLevel="signature" /> 
<uses-permission android:name="com.appoxee.example.permission.C2D_MESSAGE" />

To allow your app to use Google's Push Notification Service (GCM), add the following permissions: 

<!-- This app has permission to register and receive message -->
<!-- App receives GCM messages. -->
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" /> 
<!-- GCM connects to Google Services. -->
<uses-permission android:name="android.permission.INTERNET" /> 
<!-- GCM requires a Google account. -->
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<!-- Keeps the processor from sleeping when a message is received. -->
<uses-permission android:name="android.permission.WAKE_LOCK" />

In the manifest file's Application element, make sure your app has the name it has in your class file:

<application android:label="@string/app_name"
android:icon="@drawable/ic_launcher"
android:allowClearUserData="true"
android:enabled="true" android:name="MyApplication"/> 

...

 Add the following child element to your Application element (remember you must replace "com.appoxee.example" with your app's package name, as defined by the manifest tag):

        <!-- REQUIRED for C2DM -->
        <service android:name="com.appoxee.gcm.PlayIntentService" >
        </service>

        <receiver android:name="com.appoxee.listeners.OnCoppaReciever" />
        <receiver
            android:name="com.appoxee.gcm.PlayBroadcastReceiver"
            android:permission="com.google.android.c2dm.permission.SEND" >

            <!-- Receive the actual message -->
            <intent-filter>
                <action android:name="com.google.android.c2dm.intent.RECEIVE" />
                <category android:name="com.appoxee.example" />
            </intent-filter>

            <!-- Receive the registration id -->
            <intent-filter>
                <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
                <category android:name="com.appoxee.example" />
            </intent-filter>
        </receiver>
		<!-- Must have for Push Support by Appoxee --> 
		<activity android:name ="com.appoxee.activities.InboxMessage"/>

To enable Appoxee's in-app inbox, and other advanced features, add the following code inside your Application element:

<activity android:name="com.appoxee.activities.Inbox"/>
<activity android:name="com.appoxee.activities.MoreApps"/>
<activity android:name="com.appoxee.activities.Feedback"/> 
<!-- Add if missing from Push Integration -->
<activity android:name ="com.appoxee.activities.InboxMessage"/>

...

...

Introduction

This document explains how to add the Appoxee code to your application code (step 3 of the Appoxee Android SDK integration process).

The code sections below use the following typographic conventions:

• Regular text - existing code: You should already have this code in your project by default. No changes are required.
• Bold text - new code: Make sure you add this Appoxee code to your app code.
• Green text - comments: A comment describes the code that follows it and notes special issues you should pay attention to. Please read the comments carefully.
• Blue text - AndroidManifest.xml updates: The changes you should make in the app's AndroidManifest.xml file.

Integration Instructions

-dontwarn
# OrmLite uses reflection
-keep class com.j256.**
-keepclassmembers class com.j256.** { *; }
-keep enum com.j256.**
-keepclassmembers enum com.j256.** { *; }
-keep interface com.j256.**
-keepclassmembers interface com.j256.** { *; }
-keepattributes Signature
-keepattributes *Annotation*
-keepclassmembers class * { public <init>(android.content.Context); }

Source code integration

On your main activity class  add the following code to Activity life-cycle callback methods:

@Override
protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
		 ...
		 new initAsync(getApplicationContext(),"APP_KEY",
                     

...

...

"SECRET_KEY", true, "com.package.MainActivity").execute();
		AppoxeeManager.setDebug(true);	//set 'false' to get less debug logs 	
		...
}
 
@Override  
protected void onStart() {
	super.onStart();
	Appoxee.onStart();
	...
}

@Override
protected void onStop() {
	Appoxee.onStop();	
	super.onStop();
	...
}

public class AppoxeeExampleActivity extends Activity implements AppoxeeObserver{
	
	...
 
	@Override
	public void onRegistrationCompleted() {
		//from this point on, Appoxee API is avaliable
	}

	@Override
	public void onMessagesUpdateCompleted() {
		//callback for getting inbox messages
	}

	@Override
	public void onRegistrationFailure() {
		//Huston, we have a problem... 
	}

	@Override
	public void onGeoRegistrationFailure() {
		//This is for future support ;)
	}
 
	...

}

Appoxee.isReady() == true 

@Override  
protected void onStart() {
	super.onStart();
	Appoxee.onStart();
	...
}

@Override
protected void onStop() {
	Appoxee.onStop();	
	super.onStop();
	...
}

Advanced Options (Inbox / DeepLink (URLScheme) ) :

1. If prompted with an error, add this "Import" command to enable Appoxee SDK usage:

   Code Block
   language java linenumbers true
   import com.appoxee.Appoxee;

2. Inbox integration - after enabling the Inbox in your Appoxee account (by going to the app's Application Information page and checking Allow Inbox + Rich messages), add the Inbox to your code as follows: 

    

   Note

   The Inbox feature guarantees your ability to engage the user with rich messages (note that the Inbox cannot be disabled by users, as opposed to Push Notifications) and gives you the option to access features such as Feedback and More Apps . The Inbox must be used in your application's code in order to show it and utilize its features. The InboxMessage activity needs to be added in order to support Push Notifications by Appoxee. Check your Manifest.xml and see that it is added below the Receiver declaration.

    

   1. Add code that opens the Inbox - the Inbox can be opened from any activity. In the example code below, the Inbox is opened from the main activity layout, using the "openInbox():" function:

      Code Block
      language java linenumbers true
      public void openInbox(View view) { Intent intent = new Intent(this, Inbox.class); intent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); this.startActivity(intent); }

       

       

   2. Add a button that opens the Inbox - it is recommended to add a button to open the Inbox. This button is added in the activity layout as follows:

      Code Block
      language xml linenumbers true
      <Button android:id="@+id/open_inbox" android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="openInbox" android:text="Open Appoxee Inbox" />

       

       

   3. Show the number of unread messages - to show the user the number of unread messages, fetch this number using the following command:

      Code Block
      language java linenumbers true
      Appoxee.getUnreadMessages();

       

       

3. Deep Link / URL Scheme in Appoxee & Android

   1. Add to your AndroidManifest.xml

      Code Block
      language xml linenumbers true
      <activity android:name="com.appoxee.example.DeepLinkActivity" > <!-- Add the Intent Filter for activity needed to be URLScheme compatible --> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="example" android:host="pushnotification" /> </intent-filter> </activity>

       

       

   2. Create DeepLinkActivity.java

      Code Block
      language java title DeepLink Activity Sample linenumbers true
      //This sample extends AppoxeeBaseActivity, for onStart() & onStop() integration and analytics public class DeepLinkActivity extends AppoxeeBaseActivity { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); Intent intent = getIntent(); if (intent == null || intent.getData() == null) { finish(); } openDeepLink(intent.getData()); // Finish this activity finish(); } public void openDeepLink(Uri deepLink) { String path = deepLink.getPath(); Utils.Debug("Base path: " + path); //Implement your Code here path = path.replace("/", ""); Intent intent = new Intent(); intent.setClassName(this, path); this.startActivity(intent); } .....

You are now done integrating the Appoxee SDK! Congrats!

1. If you wish to use the SDK Sync API's - press here

2. If you wish to use the SDK Async API's - press here 

3.

...

NEXT STEP: Step 4 of the Appoxee Android SDK IntegrationIf you wish to use the Custom Push Notification Builder - press here

As mentioned earlier, our Test Application contains a full code sample. it can be downloaded from here.