com.localytics.android

Class MessagingListenerV2Adapter

java.lang.Object

com.localytics.android.MessagingListenerV2Adapter

All Implemented Interfaces:

MessagingListenerV2

public class MessagingListenerV2Adapter
extends java.lang.Object
implements MessagingListenerV2

This adapter class provides empty implementations of the methods from MessagingListenerV2. Any custom listener that cares only about a subset of the methods of this listener can simply subclass this adapter class instead of implementing the interface directly.

Constructor Summary

Constructors

Constructor and Description
MessagingListenerV2Adapter()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagingListenerV2Adapter

public MessagingListenerV2Adapter()

Method Detail

localyticsShouldShowInAppMessage

public boolean localyticsShouldShowInAppMessage(@NonNull
                                                InAppCampaign campaign)

Description copied from interface: MessagingListenerV2

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

Specified by:

localyticsShouldShowInAppMessage in interface MessagingListenerV2

Parameters:

campaign - The campaign that will be shown

Returns:

The decision to show the In-App campaign.

localyticsWillDisplayInAppMessage

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

Description copied from interface: MessagingListenerV2

Callback to modify presentation of an In-App Campaign.

Specified by:

localyticsWillDisplayInAppMessage in interface MessagingListenerV2

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

public void localyticsDidDisplayInAppMessage()

Description copied from interface: MessagingListenerV2

Callback that an in-app message was displayed.

Specified by:

localyticsDidDisplayInAppMessage in interface MessagingListenerV2

localyticsWillDismissInAppMessage

public void localyticsWillDismissInAppMessage()

Description copied from interface: MessagingListenerV2

Callback that an in-app message will be dismissed.

Specified by:

localyticsWillDismissInAppMessage in interface MessagingListenerV2

localyticsDidDismissInAppMessage

public void localyticsDidDismissInAppMessage()

Description copied from interface: MessagingListenerV2

Callback that an in-app message was dismissed.

Specified by:

localyticsDidDismissInAppMessage in interface MessagingListenerV2

localyticsShouldDelaySessionStartInAppMessages

public boolean localyticsShouldDelaySessionStartInAppMessages()

Description copied from interface: MessagingListenerV2

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.

Specified by:

localyticsShouldDelaySessionStartInAppMessages in interface MessagingListenerV2

Returns:

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

See Also:

Localytics.triggerInAppMessagesForSessionStart()

localyticsShouldShowPushNotification

public boolean localyticsShouldShowPushNotification(@NonNull
                                                    PushCampaign campaign)

Description copied from interface: MessagingListenerV2

Callback to determine if a Push campaign should be shown.

Specified by:

localyticsShouldShowPushNotification in interface MessagingListenerV2

Parameters:

campaign - An object defining a Push Campaign

Returns:

The decision to show the local notification.

localyticsShouldShowPlacesPushNotification

public boolean localyticsShouldShowPlacesPushNotification(@NonNull
                                                          PlacesCampaign campaign)

Description copied from interface: MessagingListenerV2

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

Specified by:

localyticsShouldShowPlacesPushNotification in interface MessagingListenerV2

Parameters:

campaign - An object defining a Places Campaign

Returns:

The decision to show the local notification.

localyticsWillShowPlacesPushNotification

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

Description copied from interface: MessagingListenerV2

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

Specified by:

localyticsWillShowPlacesPushNotification in interface MessagingListenerV2

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
public android.support.v4.app.NotificationCompat.Builder localyticsWillShowPushNotification(@NonNull
                                                                                                     android.support.v4.app.NotificationCompat.Builder builder,
                                                                                                     @NonNull
                                                                                                     PushCampaign campaign)

Description copied from interface: MessagingListenerV2

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

Specified by:

localyticsWillShowPushNotification in interface MessagingListenerV2

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