com.localytics.android

Interface CallToActionListener

All Known Subinterfaces:

CallToActionListenerV2

All Known Implementing Classes:

CallToActionListenerAdapter, CallToActionListenerAdapterV2

public interface CallToActionListener

An interface used to receive updates about deeplinks triggered in Localytics messaging campaigns. 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	localyticsDidOptOut(boolean optOut, Campaign campaign) A callback to indicate that a user has triggered an privacy opt in or opt out using the Javascript API provided in a Localytics In-App or Inbox message.
void	localyticsDidPrivacyOptOut(boolean optOut, Campaign campaign) A callback to indicate that a user has triggered an opt in or opt out using the Javascript API provided in a Localytics In-App or Inbox message.
boolean	localyticsShouldDeeplink(java.lang.String url, Campaign campaign)
boolean	localyticsShouldPromptForLocationPermissions(Campaign campaign) A callback to indicate that a user has triggered a location permission prompt using the Javascript API provided in a Localytics In-App or Inbox message.

Method Detail

localyticsShouldDeeplink

boolean localyticsShouldDeeplink(@NonNull
                                 java.lang.String url,
                                 @NonNull
                                 Campaign campaign)

Parameters:

url - The URL that was triggered inside a Localytics call to action from any messaging (Push, Places, In-App or Inbox) campaign

campaign - The campaign that triggered this deeplink.

Returns:

The decision to allow Localytics to handle the deeplink

localyticsDidOptOut

void localyticsDidOptOut(boolean optOut,
                         @NonNull
                         Campaign campaign)

A callback to indicate that a user has triggered an privacy opt in or opt out using the Javascript API provided in a Localytics In-App or Inbox message.

Parameters:

optOut - The result of the call to action indicating that the user opted in (false) or out (true).

campaign - The campaign which triggered the opt in/out call.

localyticsDidPrivacyOptOut

void localyticsDidPrivacyOptOut(boolean optOut,
                                @NonNull
                                Campaign campaign)

A callback to indicate that a user has triggered an opt in or opt out using the Javascript API provided in a Localytics In-App or Inbox message.

Parameters:

optOut - The result of the call to action indicating that the user opted in (false) or out (true).

campaign - The campaign which triggered the privacy opt in/out call.

localyticsShouldPromptForLocationPermissions

boolean localyticsShouldPromptForLocationPermissions(@NonNull
                                                     Campaign campaign)

A callback to indicate that a user has triggered a location permission prompt using the Javascript API provided in a Localytics In-App or Inbox message.

Parameters:

campaign - The campaign which triggered the privacy opt in/out call.

Returns:

boolean indicating if Localytics should proceed. Returning false will prevent the location prompt.