Integration

Step 1: Braze In-App Message Manager Registration

In-App Message display is managed by the AppboyInAppMessageManager class. Every activity in your app must be registered with the AppboyInAppMessageManager to allow it to add in-app message views to the view hierarchy. There are two ways to accomplish this:

Activity Lifecycle Callback Integration (Recommended)

The Activity Lifecycle Callback Integration handles in-app message registration automatically, no extra integration is required. This is the recommended integration for handling in-app message registration.

Manual In-App Message Registration

A manual in-app message registration requires 3 steps.

In your Application.onCreate(), call ensureSubscribedToInAppMessageEvents().

• JAVA
• KOTLIN

1
AppboyInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context);

1
AppboyInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context)

In every activity where in-app messages can be shown, registerInAppMessageManager() should be called in that activity’s onResume().

• JAVA
• KOTLIN

1
2
3
4
5
6
7
@Override
public void onResume() {
  super.onResume();
  // Registers the AppboyInAppMessageManager for the current Activity. This Activity will now listen for
  // in-app messages from Braze.
  AppboyInAppMessageManager.getInstance().registerInAppMessageManager(activity);
}

1
2
3
4
5
6
public override fun onResume() {
  super.onResume()
  // Registers the AppboyInAppMessageManager for the current Activity. This Activity will now listen for
  // in-app messages from Braze.
  AppboyInAppMessageManager.getInstance().registerInAppMessageManager(this)
}

In every activity where registerInAppMessageManager() was called, unregisterInAppMessageManager() should be called in that activity’s onPause().

• JAVA
• KOTLIN

1
2
3
4
5
6
@Override
public void onPause() {
  super.onPause();
  // Unregisters the AppboyInAppMessageManager for the current Activity.
  AppboyInAppMessageManager.getInstance().unregisterInAppMessageManager(activity);
}

1
2
3
4
5
public override fun onPause() {
  super.onPause()
  // Unregisters the AppboyInAppMessageManager.
  AppboyInAppMessageManager.getInstance().unregisterInAppMessageManager(this)
}

Step 2: (Optional) In-App Message Manager Blacklist

In your integration, you may require that certain Activities in your app should not show In-App Messages. The Activity Lifecycle Callback Integration provides an easy way to accomplish this.

The following example code adds two Activities to the In-App Message registration blacklist, SplashActivity and SettingsActivity.

• JAVA
• KOTLIN

1
2
3
4
5
6
7
8
9
10
public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    Set<Class> inAppMessageBlacklist = new HashSet<>();
    inAppMessageBlacklist.add(SplashActivity.class);
    inAppMessageBlacklist.add(SettingsActivity.class);
    registerActivityLifecycleCallbacks(new AppboyLifecycleCallbackListener(inAppMessageBlacklist));
  }
}

1
2
3
4
5
6
7
8
9
class MyApplication : Application() {
  override fun onCreate() {
    super.onCreate()
    val inAppMessageBlacklist = HashSet<Class<*>>()
    inAppMessageBlacklist.add(SplashActivity::class.java)
    inAppMessageBlacklist.add(SettingsActivity::class.java)
    registerActivityLifecycleCallbacks(AppboyLifecycleCallbackListener(inAppMessageBlacklist))
  }
}

See the AppboyLifecycleCallbackListener constructor javadocs for more information.