Migrating from previous versions / Migrate from v2 to v3 |
A list of the method signature changes from SDK v2 to v3.
v2 | v3 |
---|---|
+(LocalyticsSession *)sharedLocalyticsSession; |
removed |
+(LocalyticsSession *)shared; |
removed |
+(LocalyticsAmpSession *)shared; |
removed |
Integration | |
---|---|
-(void)integrateLocalytics:(NSString *)appKey launchOptions:(NSDictionary*)launchOptions; |
+(void)autoIntegrate:(NSString *)appKey launchOptions:(NSDictionary *)launchOptions; |
-(void)LocalyticsSession:(NSString *)appKey; |
+(void)integrate:(NSString *)appKey; |
-(void)integratePushNotifications:(UIRemoteNotificationType)remoteNotificationType |
removed |
-(void)startSession:(NSString *)appKey; |
removed |
-(void)open; |
+(void)openSession; |
-(void)resume; |
+(void)openSession;now supports both opening and resuming |
-(void)close; |
+(void)closeSession; |
-(void)upload; |
+(void)upload; |
Events | |
---|---|
-(void)tagEvent:(NSString *)event; |
+(void)tagEvent:(NSString *)event; |
-(void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes; |
+(void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes; |
-(void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes customerValueIncrease:(NSNumber *)customerValueIncrease; |
+(void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes customerValueIncrease:(NSNumber *)customerValueIncrease; |
-void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes reportAttributes:(NSDictionary *)reportAttributes; |
reportAttributesremoved |
-(void)tagEvent:(NSString *)event attributes:(NSDictionary *)attributes reportAttributes:(NSDictionary *)reportAttributes customerValueIncrease: (NSNumber*)customerValueIncrease; |
reportAttributesremoved |
-(void)tagScreen:(NSString *)screen; |
+(void)tagScreen:(NSString *)screen; |
Custom Dimensions | |
---|---|
- (void)setCustomDimension:(int)dimension value:(NSString *)value; |
+ (void)setValue:(NSString *)value forCustomDimension:(NSUInteger)dimension; |
+ (NSString *)valueForCustomDimension:(NSUInteger)dimension; |
Identifiers | |
---|---|
-(void)setCustomerId:(NSString *)customerId; |
+(void)setCustomerId:(NSString *)setCustomerId; |
+(NSString *)getCustomerId; |
|
-(void)setValueForIdentifier:(NSString *)identifierName value:(NSString*)value; |
+(void)setValue:(NSString *)value forIdentifier:(NSString *)identifier; |
+(NSString *)valueForIdentifier:(NSString *)identifier; |
|
-(void)setCustomerName:(NSString *)email; |
use setValue:forIdentifier:with identifier "customer_name" |
-(void)setCustomerEmail:(NSString *)email; |
use setValue:forIdentifier:with identifier "email" |
Profile Attributes | |
---|---|
-(void)setProfileValue:(NSObject<NSCopying> *)value forAttribute:(NSString*)attribute; |
+(void)setValue:(NSObject<NSCopying> *)value forProfileAttribute: (NSString *)attribute withScope:(LLProfileScope)scope; |
+(void)setValue:(NSObject<NSCopying> *)value forProfileAttribute: (NSString*)attribute; |
|
+(void)addValues:(NSArray *)values toSetForProfileAttribute: (NSString *)attributewithScope:(LLProfileScope)scope; |
|
+(void)addValues:(NSArray *)values toSetForProfileAttribute: (NSString*)attribute; |
|
+(void)removeValues:(NSArray *)values fromSetForProfileAttribute: (NSString *)attributewithScope:(LLProfileScope)scope; |
|
+(void)removeValues:(NSArray *)values fromSetForProfileAttribute: (NSString*)attribute; |
|
+(void)incrementValueBy:(NSInteger)value forProfileAttribute: (NSString*)attributewithScope:(LLProfileScope)scope; |
|
+(void)incrementValueBy:(NSInteger)value forProfileAttribute: (NSString*)attribute; |
|
+(void)decrementValueBy:(NSInteger)value forProfileAttribute: (NSString *)attributewithScope:(LLProfileScope)scope; |
|
+(void)decrementValueBy:(NSInteger)value forProfileAttribute: (NSString*)attribute; |
|
+(void)deleteProfileAttribute:(NSString *)attributewithScope: (LLProfileScope)scope; |
|
+(void)deleteProfileAttribute:(NSString *)attribute; |
Push Messaging | |
---|---|
-(void)setPushToken:(NSData *)pushToken; |
+(void)setPushToken:(NSData *)pushToken; |
+(NSString *)pushToken; |
|
+(void)handlePushNotificationOpened:(NSDictionary *)notificationInfo; |
In-App Messaging | |
---|---|
-(void)ampTrigger:(NSString *)event; |
+(void)triggerInAppMessage:(NSString *)trigger; |
-(void)ampTrigger:(NSString *)event attributes: (NSDictionary *)attributes; |
+(void)triggerInAppMessage:(NSString *)trigger withAttributes:(NSDictionary*)attributes; |
-(void)ampTrigger:(NSString *)event attributes: (NSDictionary *)attributesreportAttributes: (NSDictionary *)reportAttributes; |
reportAttributesremoved |
@property (assign) BOOL displayButtonOnLeft; |
+(void)setInAppMessageDismissButtonLocation:(LLInAppMessageDismissButtonLocation)location; |
+(LLInAppMessageDismissButtonLocation)inAppMessageDismissButtonLocation; |
|
@property (nonatomic, readonly) UIImage* dismissButtonImage; |
removed |
-(void)setDismissButtonImageWithImage:(UIImage *)image; |
+(void)setInAppMessageDismissButtonImage:(UIImage *)image; |
-(void)setDismissButtonImageWithName:(NSString *)imageName; |
+(void)setInAppMessageDismissButtonImageWithName:(NSString *)imageName; |
+(void)dismissCurrentInAppMessage; |
|
-(BOOL)handleURL:(NSURL *)url; |
+(BOOL)handleTestModeURL:(NSURL *)url; |
@property (assign) BOOL testModeEnabled; |
+(BOOL)isTestModeEnabled; |
+(void)setTestModeEnabled:(BOOL)enabled; |
Settings | |
---|---|
@property (nonatomic, assign) BOOL enableHTTPS; |
removed |
@property (nonatomic, assign) BOOL loggingEnabled; |
+(BOOL)isLoggingEnabled; |
+(void)setLoggingEnabled:(BOOL)loggingEnabled; |
|
@property (nonatomic, assign) BOOL advertisingIdentifierEnabled; |
+(BOOL)isCollectingAdvertisingIdentifier; |
+(void)setCollectAdvertisingIdentifier:(BOOL)collectAdvertisingIdentifier; |
|
@property (atomic) float sessionTimeoutInterval; |
+(NSTimeInterval)sessionTimeoutInterval; |
+(void)setSessionTimeoutInterval:(NSTimeInterval)timeoutInterval; |
|
-(void)setOptIn:(BOOL)optedIn; |
+(BOOL)isOptedOut; |
+(void)setOptedOut:(BOOL)optedOut; |
|
-(void)setLocation:(CLLocationCoordinate2D)deviceLocation; |
+(void)setLocation:(CLLocationCoordinate2D)location; |
+(NSString *)installId; |
|
+(NSString *)libraryVersion; |
|
+(NSString *)appKey; |
Delegates | |
---|---|
@property (nonatomic, assign) id<LocalyticsSessionDelegate>localyticsDelegate; |
+(void)addAnalyticsDelegate:(id<LLAnalyticsDelegate>)delegate; |
+(void)removeAnalyticsDelegate:(id<LLAnalyticsDelegate>)delegate; |
|
property (nonatomic, assign) id<LocalyticsAmpSessionDelegate>ampDelegate; |
+(void)addMessagingDelegate:(id<LLMessagingDelegate>)delegate; |
+(void)removeMessagingDelegate:(id<LLMessagingDelegate>)delegate; |