Migrating from previous versions / Migrate from v2 to v3
Parent topic: Migrate from v2 to v3

Method Signature Changes

You can do a simple text-replacement to replace all references to a LocalyticsSession or LocalyticsAmpSession object with the Localytics class.

Table 1. Integration
v2 v3 
LocalyticsSession(Context);
 removed 
LocalyticsSession(Context, String);
 removed 
LocalyticsAmpSession(Context);
 removed 
LocalyticsAmpSession(Context, String);
 removed
  
static void integrate(Context);
 
void open();
 
static void openSession();
 
void open(List<String>);
 removed 
void close();
 
static void closeSession();
 
void close(List<String>);
 removed 
void upload();
 
static void upload();
 
void upload(Runnable);
 removed
Table 2. Events
v2 v3 
void tagEvent(String);
 
static void tagEvent(String);
 
void tagEvent(String, Map<String, String>);
 
static void tagEvent(String, Map<String, String>);
 
void tagEvent(String, Map<String, String>, List<String>);
 removed 
void tagEvent(String, Map<String, String>, List<String>, long);
 removed
  
static void tagEvent(String, Map<String, String>, long);
 
void tagScreen(String);
 
static void tagScreen(String);
Table 3. Custom Dimensions
v2 v3 
void setCustomDimension(int, String);
 
static void setCustomDimension(int, String);
 
String getCustomDimension(int);
 
static String getCustomDimension(int);
Table 4. Identifiers
v2 v3 
void setCustomerId(String);
 
static void setCustomerId(String);
  
static String getCustomerId();
 
void setCustomerData(String, String);
 
static void setIdentifier(String, String);
 
void setCustomerEmail(String);
 use setIdentifier with identifier "email"
void setCustomerName(String); use setIdentifier with identifier "customer_name"
  static String getIdentifier(String);
Table 5. Profile Attributes
v2 v3 
void setProfileAttribute(String, Object);
 removed
  static void setProfileAttribute(String, long, ProfileScope);
  static void setProfileAttribute(String, long);
  static void setProfileAttribute(String, long[], ProfileScope);
  static void setProfileAttribute(String, long[]);
  static void setProfileAttribute(String, String, ProfileScope);
  static void setProfileAttribute(String, String);
  static void setProfileAttribute(String, String[], ProfileScope);
  static void setProfileAttribute(String, String[]);
  static void setProfileAttribute(String, Date, ProfileScope);
  static void setProfileAttribute(String, Date);
  static void setProfileAttribute(String, Date[], ProfileScope);
  static void setProfileAttribute(String, Date[]);
  static void addProfileAttributesToSet(String, long[], ProfileScope);
  static void addProfileAttributesToSet(String, long[]);
  static void addProfileAttributesToSet(String, String[], ProfileScope);
  static void addProfileAttributesToSet(String, String[]);
  static void addProfileAttributesToSet(String, Date[], ProfileScope);
  static void addProfileAttributesToSet(String, Date[]);
  static void removeProfileAttributesFromSet(String, long[], ProfileScope);
  static void removeProfileAttributesFromSet(String, long[]);
  static void removeProfileAttributesFromSet(String, String[], ProfileScope);
  static void removeProfileAttributesFromSet(String, String[]);
  static void removeProfileAttributesFromSet(String, Date[], ProfileScope);
  static void removeProfileAttributesFromSet(String, Date[]);
  static void incrementProfileAttribute(String, long, ProfileScope);
  static void incrementProfileAttribute(String, long);
  static void decrementProfileAttribute(String, long, ProfileScope);
  static void decrementProfileAttribute(String, long);
  static void deleteProfileAttribute(String, ProfileScope);
  static void deleteProfileAttribute(String);
Table 6. Push Messaging
v2 v3 
void registerPush(String);
 
static void registerPush(String);
 
void setPushDisabled(boolean);
 
static void setPushDisabled(boolean);
 
void handlePushReceived(Intent);
 
static void handlePushNotificationOpened(Intent);
 
void handlePushReceived(Intent, List<String>);
 removed 
void setPushRegistrationId(String);
 removed 
void handleRegistration(Intent);
 removed 
void handleNotificationReceived(Intent);
 removed
  
static boolean isPushDisabled();
  
static void setPushRegistrationId(String);
  
static String getPushRegistrationId();
Table 7. In-App Messaging
v2 v3 
void attach(FragmentActivity);
 
static void setInAppMessageDisplayActivity(FragmentActivity);
 
void detach();
 
static void clearInAppMessageDisplayActivity();
  
static void setInAppMessageDismissButtonLocation(InAppDismissButtonLocation);
  
static InAppMessageDismissButtonLocation getInAppMessageDismissButtonLocation();
 
void setDismissButtonImage(Resources, int);
 
static void setInAppMessageDismissButtonImage(Resources, int);
 
void setDismissButtonImage(Resources, Bitmap);
 
static void setInAppMessageDismissButtonImage(Resources, Bitmap);
 
boolean isTestModeEnabled();
 
static boolean isTestModeEnabled();
 
void setTestModeEnabled(boolean);
 
static void setTestModeEnabled(boolean);
 
void handleIntent(Intent);
 
static void handleTestMode(Intent);
 
void handleIntent(Intent, String);
 removed 
void ampTrigger(String);
 
static void triggerInAppMessage(String);
 
void ampTrigger(String, Map<String, String>);
 
static void triggerInAppMessage(String, Map<String, String>);
Table 8. Settings
v2 v3 
void setHttpsEnabled(boolean);
 removed 
boolean isUsingHttps();
 removed 
void setLoggingEnabled(boolean);
 
static void setLoggingEnabled(boolean);
 
boolean isLoggingEnabled();
 
static boolean isLoggingEnabled();
 
void setSessionExpiration(long);
 
static void setSessionTimeoutInterval(long);
 
long getSessionExpiration();
 
static long getSessionTimeoutInterval();
 
void setOptOut(boolean);
 
static void setOptedOut(boolean);
  
static boolean isOptedOut();
 
void setLocation(Location);
 
static void setLocation(Location);
 
String createRangedAttribute(int, int, int, int);
 removed 
String createRangedAttribute(int, int[]);
 removed 
String getAnalyticsURL();
 removed 
void setAnalyticsURL(String);
 removed 
String getProfilesURL();
 removed 
void setProfilesURL(String);
 removed
Table 9. Listeners
v2 v3
  
static void addAnalyticsListener(AnalyticsListener);
  
static void removeAnalyticsListener(AnalyticsListener);
  
static void addMessagingListener(MessagingListener);
  
static void addMessagingListener(MessagingListener);
Parent topic: Migrate from v2 to v3