public class

LegacyInAppMessageManager

extends AirshipComponent
java.lang.Object
   ↳ com.urbanairship.AirshipComponent
     ↳ com.urbanairship.iam.LegacyInAppMessageManager

Class Overview

Legacy in-app message manager.

Summary

Nested Classes
interface LegacyInAppMessageManager.MessageBuilderExtender Interface to extend the InAppMessage.Builder that generates the message from a legacy in-app message. 
interface LegacyInAppMessageManager.ScheduleBuilderExtender Interface to extend the Schedule.Builder that generates the in-app schedule info from a legacy in-app message. 
Constants
float DEFAULT_BORDER_RADIUS_DP Default border radius.
int DEFAULT_PRIMARY_COLOR Default primary color.
int DEFAULT_SECONDARY_COLOR Default secondary color.
[Expand]
Inherited Fields
From class com.urbanairship.AirshipComponent
Public Methods
boolean getDisplayAsapEnabled()
Determines whether legacy messages will display immediately upon arrival, instead of waiting until the following foreground.
void setDisplayAsapEnabled(boolean enabled)
Sets whether legacy messages will display immediately upon arrival, instead of waiting until the following foreground.
void setMessageBuilderExtender(LegacyInAppMessageManager.MessageBuilderExtender messageBuilderExtender)
Sets the in-app message builder extender.
void setScheduleBuilderExtender(LegacyInAppMessageManager.ScheduleBuilderExtender scheduleBuilderExtender)
Sets the in-app schedule info builder extender.
static LegacyInAppMessageManager shared()
Gets the shared Legacy In-App Message Manager instance.
Protected Methods
void init()
Initialize the manager.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final float DEFAULT_BORDER_RADIUS_DP

Default border radius.

Constant Value: 2.0

public static final int DEFAULT_PRIMARY_COLOR

Default primary color.

Constant Value: -1 (0xffffffff)

public static final int DEFAULT_SECONDARY_COLOR

Default secondary color.

Constant Value: -16777216 (0xff000000)

Public Methods

public boolean getDisplayAsapEnabled ()

Determines whether legacy messages will display immediately upon arrival, instead of waiting until the following foreground.

Returns
  • true if immediate display is enabled, otherwise false.

public void setDisplayAsapEnabled (boolean enabled)

Sets whether legacy messages will display immediately upon arrival, instead of waiting until the following foreground. Defaults to true.

Parameters
enabled Whether immediate display is enabled.

public void setMessageBuilderExtender (LegacyInAppMessageManager.MessageBuilderExtender messageBuilderExtender)

Sets the in-app message builder extender.

Parameters
messageBuilderExtender The extender.

public void setScheduleBuilderExtender (LegacyInAppMessageManager.ScheduleBuilderExtender scheduleBuilderExtender)

Sets the in-app schedule info builder extender.

Parameters
scheduleBuilderExtender The extender.

public static LegacyInAppMessageManager shared ()

Gets the shared Legacy In-App Message Manager instance.

Returns
  • The shared Legacy In-App Message Manager instance.

Protected Methods

protected void init ()

Initialize the manager. Called in UAirship during takeoff.