com.localytics.android

Interface MessagingListenerV2

All Known Implementing Classes:

MessagingListenerV2Adapter

public interface MessagingListenerV2

An interface used to receive messaging callbacks. Note, all methods invoked by this interface will be invoked on the main thread. As a result, please ensure that no calls perform any blocking operations.

Method Summary

Modifier and Type	Method and Description
void	localyticsDidDismissInAppMessage() Callback that an in-app message was dismissed.
void	localyticsDidDisplayInAppMessage() Callback that an in-app message was displayed.
boolean	localyticsShouldDelaySessionStartInAppMessages() Callback to determine if In-App campaigns triggered by session start should be shown.
boolean	localyticsShouldShowInAppMessage(InAppCampaign campaign) Callback to determine if an In-App campaign should be shown.
boolean	localyticsShouldShowPlacesPushNotification(PlacesCampaign campaign) Callback to determine if the triggering of a Places campaign should show a local notification.
boolean	localyticsShouldShowPushNotification(PushCampaign campaign) Callback to determine if a Push campaign should be shown.
void	localyticsWillDismissInAppMessage() Callback that an in-app message will be dismissed.
InAppConfiguration	localyticsWillDisplayInAppMessage(InAppCampaign campaign, InAppConfiguration configuration) Callback to modify presentation of an In-App Campaign.
android.support.v4.app.NotificationCompat.Builder	localyticsWillShowPlacesPushNotification(android.support.v4.app.NotificationCompat.Builder builder, PlacesCampaign campaign) Callback to determine if a Push campaign should show a local notification.
android.support.v4.app.NotificationCompat.Builder	localyticsWillShowPushNotification(android.support.v4.app.NotificationCompat.Builder builder, PushCampaign campaign) Callback to determine if a Push campaign should show a local notification.

Method Detail

localyticsShouldShowInAppMessage

boolean localyticsShouldShowInAppMessage(@NonNull
                                         InAppCampaign campaign)

Callback to determine if an In-App campaign should be shown.

Parameters:

campaign - The campaign that will be shown

Returns:

The decision to show the In-App campaign.

localyticsWillDisplayInAppMessage

@NonNull
InAppConfiguration localyticsWillDisplayInAppMessage(@NonNull
                                                              InAppCampaign campaign,
                                                              @NonNull
                                                              InAppConfiguration configuration)

Callback to modify presentation of an In-App Campaign.

Parameters:

campaign - An immutable object representing the campaign that will be shown

configuration - An object representing the mutable visual state of the In-App campaign

Returns:

The modified configuration object containing all preferred display values.

See Also:

InAppConfiguration

localyticsDidDisplayInAppMessage

void localyticsDidDisplayInAppMessage()

Callback that an in-app message was displayed.

localyticsWillDismissInAppMessage

void localyticsWillDismissInAppMessage()

Callback that an in-app message will be dismissed.

localyticsDidDismissInAppMessage

void localyticsDidDismissInAppMessage()

Callback that an in-app message was dismissed.

localyticsShouldDelaySessionStartInAppMessages

boolean localyticsShouldDelaySessionStartInAppMessages()

Callback to determine if In-App campaigns triggered by session start should be shown. This callback is useful for integrations that want to delay presentation of startup campaigns due to the fact that they have some startup state, such as a splash screen.

Returns:

The decision to delay in-app campaigns triggered by the "Session Start" event.

See Also:

Localytics.triggerInAppMessagesForSessionStart()

localyticsShouldShowPushNotification

boolean localyticsShouldShowPushNotification(@NonNull
                                             PushCampaign campaign)

Callback to determine if a Push campaign should be shown.

Parameters:

campaign - An object defining a Push Campaign

Returns:

The decision to show the local notification.

localyticsShouldShowPlacesPushNotification

boolean localyticsShouldShowPlacesPushNotification(@NonNull
                                                   PlacesCampaign campaign)

Callback to determine if the triggering of a Places campaign should show a local notification.

Parameters:

campaign - An object defining a Places Campaign

Returns:

The decision to show the local notification.

localyticsWillShowPlacesPushNotification

@NonNull
android.support.v4.app.NotificationCompat.Builder localyticsWillShowPlacesPushNotification(@NonNull
                                                                                                    android.support.v4.app.NotificationCompat.Builder builder,
                                                                                                    @NonNull
                                                                                                    PlacesCampaign campaign)

Callback to determine if a Push campaign should show a local notification.

Parameters:

builder - The Android Notification builder used to customize a local notification.

campaign - The campaign that triggered the push notification

Returns:

The Android Notification Builder with all updated preferences

localyticsWillShowPushNotification

@NonNull
android.support.v4.app.NotificationCompat.Builder localyticsWillShowPushNotification(@NonNull
                                                                                              android.support.v4.app.NotificationCompat.Builder builder,
                                                                                              @NonNull
                                                                                              PushCampaign campaign)

Callback to determine if a Push campaign should show a local notification.

Parameters:

builder - The Android Notification builder used to customize a local notification.

campaign - The campaign that triggered the push notification

Returns:

The Android Notification Builder with all updated preferences