Live Updates API reference

The APIs on this page are available on the LiveUpdates class, in the com.adobe.marketing.mobile.messaging.liveupdate package.

To add the Live Updates plugin to your app, use the Mobile Core addPlugins API, as shown in Register the plugin. For the classes and interfaces used by these APIs, see Public classes and interfaces.

extensionVersion

The extensionVersion API returns the version of the Live Updates library.

Android Java

data-slots=heading, code

data-repeat=2

public static String extensionVersion()

String version = LiveUpdates.extensionVersion();

Android Kotlin

data-slots=heading, code

data-repeat=1

val version = LiveUpdates.extensionVersion()

setLiveUpdateListener

The setLiveUpdateListener API sets an ILiveUpdateListener that receives Live Update lifecycle and interaction callbacks. Only one listener is active at a time. Pass null to remove the current listener.

Set the listener in the onCreate method of your Application class. The onClick and onDismissed callbacks can arrive after the app process was stopped, when Android starts the app only to handle the interaction, so a listener set from an Activity may miss them.

Android Java

data-slots=heading, code

data-repeat=2

public static void setLiveUpdateListener(@Nullable ILiveUpdateListener listener)

LiveUpdates.setLiveUpdateListener(new ILiveUpdateListener() {
    @Override
    public void onLiveUpdateReceived(@NonNull LiveUpdatePayload payload) {}

    @Override
    public void onStart(@NonNull LiveUpdatePayload payload) {
        // The Live Update has started.
    }

    @Override
    public void onUpdate(@NonNull LiveUpdatePayload payload) {}

    @Override
    public void onEnd(@NonNull LiveUpdatePayload payload) {}

    @Override
    public void onClick(@NonNull LiveUpdatePayload payload) {}

    @Override
    public void onDismissed(@NonNull LiveUpdatePayload payload) {}
});

Android Kotlin

data-slots=heading, code

data-repeat=1

LiveUpdates.setLiveUpdateListener(object : ILiveUpdateListener {
    override fun onStart(payload: LiveUpdatePayload) {
        // The Live Update has started.
    }
})

getLiveUpdateListener

The getLiveUpdateListener API returns the listener set with setLiveUpdateListener, or null when no listener is set.

Android Java

data-slots=heading, code

data-repeat=2

@Nullable
public static ILiveUpdateListener getLiveUpdateListener()

ILiveUpdateListener listener = LiveUpdates.getLiveUpdateListener();

Android Kotlin

data-slots=heading, code

data-repeat=1

val listener = LiveUpdates.getLiveUpdateListener()

setLiveUpdateInterceptor

The setLiveUpdateInterceptor API sets an ILiveUpdateInterceptor that decides whether an incoming Live Update is shown. The interceptor is called before the Live Update is displayed or tracked, and before any listener callback. Only one interceptor is active at a time. Pass null to remove the current interceptor.

The interceptor is called for Live Updates displayed by the plugin, including those raised with triggerLocalLiveUpdate. It is not called in manual mode. For typical uses, see Suppress updates with an interceptor.

Android Java

data-slots=heading, code

data-repeat=2

public static void setLiveUpdateInterceptor(@Nullable ILiveUpdateInterceptor interceptor)

LiveUpdates.setLiveUpdateInterceptor(payload -> {
    // Return false to drop this Live Update, or true to show it.
    return shouldShowLiveUpdate(payload);
});

Android Kotlin

data-slots=heading, code

data-repeat=1

LiveUpdates.setLiveUpdateInterceptor(object : ILiveUpdateInterceptor {
    override fun shouldDisplayLiveUpdate(payload: LiveUpdatePayload): Boolean {
        // Return false to drop this Live Update, or true to show it.
        return shouldShowLiveUpdate(payload)
    }
})

getLiveUpdateInterceptor

The getLiveUpdateInterceptor API returns the interceptor set with setLiveUpdateInterceptor, or null when no interceptor is set.

Android Java

data-slots=heading, code

data-repeat=2

@Nullable
public static ILiveUpdateInterceptor getLiveUpdateInterceptor()

ILiveUpdateInterceptor interceptor = LiveUpdates.getLiveUpdateInterceptor();

Android Kotlin

data-slots=heading, code

data-repeat=1

val interceptor = LiveUpdates.getLiveUpdateInterceptor()

triggerLocalLiveUpdate

The triggerLocalLiveUpdate API displays a Live Update from your app, without a push. The Live Update is processed the same way as a received push: the interceptor is called, the payload is validated, the style provider supplies the style, the notification is posted, and the listener's onStart callback is called.

Build the payload with LiveUpdatePayload.create, using EVENT_TYPE_LOCAL_START as the event type and the current time, in epoch seconds, as the timestamp. Later pushes for the same Live Update must have a newer timestamp, or they are dropped.

A local start is not tracked when it is displayed. It is reported when the first push from Adobe Journey Optimizer for the same Live Update arrives. See Local start is reported only after a push.

Android Java

data-slots=heading, code

data-repeat=2

public static boolean triggerLocalLiveUpdate(@NonNull Context context, @NonNull LiveUpdatePayload payload)

Example

LiveUpdatePayload payload = LiveUpdatePayload.create(
    "order_1234",
    "live_updates_channel",
    LiveUpdatePayload.EVENT_TYPE_LOCAL_START,
    "Order on the way",
    System.currentTimeMillis() / 1000
);
LiveUpdates.triggerLocalLiveUpdate(context, payload);

Android Kotlin

data-slots=heading, code

data-repeat=1

val payload = LiveUpdatePayload.create(
    notificationId = "order_1234",
    channelId = "live_updates_channel",
    eventType = LiveUpdatePayload.EVENT_TYPE_LOCAL_START,
    title = "Order on the way",
    timestamp = System.currentTimeMillis() / 1000
)
LiveUpdates.triggerLocalLiveUpdate(context, payload)

trackTopicSubscribed

The trackTopicSubscribed API sends a tracking event to Adobe Journey Optimizer when your app subscribes the device to the Firebase Cloud Messaging (FCM) topic of a Live Update. The SDK does not subscribe the device to topics. Your app subscribes with FirebaseMessaging.subscribeToTopic, and calls this API after the subscription succeeds. See Broadcast Live Updates.

The topic is read from the payload's topicName. No event is sent when the payload has no topic name or no Adobe Journey Optimizer tracking data.

Android Java

data-slots=heading, code

data-repeat=2

public static void trackTopicSubscribed(@NonNull LiveUpdatePayload payload)

FirebaseMessaging.getInstance().subscribeToTopic(topic)
    .addOnCompleteListener(task -> {
        if (task.isSuccessful()) {
            LiveUpdates.trackTopicSubscribed(payload);
        }
    });

Android Kotlin

data-slots=heading, code

data-repeat=1

FirebaseMessaging.getInstance().subscribeToTopic(topic)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            LiveUpdates.trackTopicSubscribed(payload)
        }
    }

trackTopicUnsubscribed

The trackTopicUnsubscribed API sends a tracking event to Adobe Journey Optimizer when your app unsubscribes the device from the FCM topic of a Live Update. Call it after FirebaseMessaging.unsubscribeFromTopic succeeds.

The topic is read from the payload's topicName. No event is sent when the payload has no topic name or no Adobe Journey Optimizer tracking data.

Android Java

data-slots=heading, code

data-repeat=2

public static void trackTopicUnsubscribed(@NonNull LiveUpdatePayload payload)

FirebaseMessaging.getInstance().unsubscribeFromTopic(topic)
    .addOnCompleteListener(task -> {
        if (task.isSuccessful()) {
            LiveUpdates.trackTopicUnsubscribed(payload);
        }
    });

Android Kotlin

data-slots=heading, code

data-repeat=1

FirebaseMessaging.getInstance().unsubscribeFromTopic(topic)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            LiveUpdates.trackTopicUnsubscribed(payload)
        }
    }

addPushTrackingDetails

data-variant=info

data-slots=text

The addPushTrackingDetails API adds the Live Update tracking details to an Intent that your app uses for the notification's PendingIntent. When the user interacts with the notification, pass the received Intent to handleNotificationResponse to send the interaction tracking event.

Android Java

data-slots=heading, code

data-repeat=2

public static boolean addPushTrackingDetails(@Nullable Intent intent, @Nullable RemoteMessage message)

Example

Intent intent = new Intent(context, MainActivity.class);
LiveUpdates.addPushTrackingDetails(intent, remoteMessage);

Android Kotlin

data-slots=heading, code

data-repeat=1

val intent = Intent(context, MainActivity::class.java)
LiveUpdates.addPushTrackingDetails(intent, remoteMessage)

trackLiveUpdateEvent

data-variant=info

data-slots=text

The trackLiveUpdateEvent API sends the tracking event for a received Live Update and calls the registered ILiveUpdateListener. Call it after your app posts the notification. When the push has no Adobe Journey Optimizer tracking data, no tracking event is sent, but the listener is still called.

Android Java

data-slots=heading, code

data-repeat=2

public static void trackLiveUpdateEvent(@NonNull Context context, @NonNull RemoteMessage message)

LiveUpdates.trackLiveUpdateEvent(context, remoteMessage);

Android Kotlin

data-slots=heading, code

data-repeat=1

LiveUpdates.trackLiveUpdateEvent(context, remoteMessage)

handleNotificationResponse

data-variant=info

data-slots=text

The handleNotificationResponse API sends the tracking event for a user interaction with a Live Update notification: a tap, an action button click, or a dismissal. Call it with the Intent your app receives from the notification. The Intent must have been prepared with addPushTrackingDetails.

Android Java

data-slots=heading, code

data-repeat=2

public static boolean handleNotificationResponse(@Nullable Intent intent, boolean applicationOpened)

public static boolean handleNotificationResponse(@Nullable Intent intent, boolean applicationOpened, @Nullable String customActionId)

Example

// The user tapped the notification.
LiveUpdates.handleNotificationResponse(intent, true);

// The user dismissed the notification.
LiveUpdates.handleNotificationResponse(intent, false, LiveUpdates.ACTION_ID_DISMISS);

Android Kotlin

data-slots=heading, code

data-repeat=1

// The user tapped the notification.
LiveUpdates.handleNotificationResponse(intent, applicationOpened = true)

// The user dismissed the notification.
LiveUpdates.handleNotificationResponse(
    intent,
    applicationOpened = false,
    customActionId = LiveUpdates.ACTION_ID_DISMISS
)