diff --git a/Localytics-Android-Latest/androida_xamarinfork_6.3.7.version b/Localytics-Android-Latest/androida_xamarinfork_6.4.0.version similarity index 100% rename from Localytics-Android-Latest/androida_xamarinfork_6.3.7.version rename to Localytics-Android-Latest/androida_xamarinfork_6.4.0.version diff --git a/Localytics-Android-Latest/localytics.aar b/Localytics-Android-Latest/localytics.aar index 68caa70..5029833 100644 Binary files a/Localytics-Android-Latest/localytics.aar and b/Localytics-Android-Latest/localytics.aar differ diff --git a/Localytics-iOS-Latest/Localytics.framework/Headers/Localytics.h b/Localytics-iOS-Latest/Localytics.framework/Headers/Localytics.h index dd0e67d..f14fedd 100644 --- a/Localytics-iOS-Latest/Localytics.framework/Headers/Localytics.h +++ b/Localytics-iOS-Latest/Localytics.framework/Headers/Localytics.h @@ -38,7 +38,7 @@ @class WKWebViewConfiguration; @class UNMutableNotificationContent; -#define LOCALYTICS_LIBRARY_VERSION @"6.2.9" //iOS version +#define LOCALYTICS_LIBRARY_VERSION @"6.3.0" //iOS version #else diff --git a/Localytics-iOS-Latest/Localytics.framework/Info.plist b/Localytics-iOS-Latest/Localytics.framework/Info.plist index 38a769e..de5c504 100644 Binary files a/Localytics-iOS-Latest/Localytics.framework/Info.plist and b/Localytics-iOS-Latest/Localytics.framework/Info.plist differ diff --git a/Localytics-iOS-Latest/Localytics.framework/Localytics b/Localytics-iOS-Latest/Localytics.framework/Localytics index a666f9d..1d83526 100755 Binary files a/Localytics-iOS-Latest/Localytics.framework/Localytics and b/Localytics-iOS-Latest/Localytics.framework/Localytics differ diff --git a/Localytics-iOS-Latest/Localytics.framework/PrivacyInfo.xcprivacy b/Localytics-iOS-Latest/Localytics.framework/PrivacyInfo.xcprivacy new file mode 100644 index 0000000..f727185 --- /dev/null +++ b/Localytics-iOS-Latest/Localytics.framework/PrivacyInfo.xcprivacy @@ -0,0 +1,89 @@ + + + + + NSPrivacyAccessedAPITypes + + + NSPrivacyAccessedAPIType + NSPrivacyAccessedAPICategoryUserDefaults + NSPrivacyAccessedAPITypeReasons + + CA92.1 + + + + NSPrivacyAccessedAPIType + NSPrivacyAccessedAPICategoryFileTimestamp + NSPrivacyAccessedAPITypeReasons + + C617.1 + + + + NSPrivacyAccessedAPITypeReasons + + CA92.1 + + NSPrivacyAccessedAPIType + NSPrivacyAccessedAPICategoryUserDefaults + + + NSPrivacyAccessedAPIType + NSPrivacyAccessedAPICategoryDiskSpace + NSPrivacyAccessedAPITypeReasons + + E174.1 + + + + NSPrivacyTracking + + NSPrivacyCollectedDataTypes + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeCoarseLocation + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeAnalytics + NSPrivacyCollectedDataTypePurposeProductPersonalization + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeUserID + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeAnalytics + NSPrivacyCollectedDataTypePurposeProductPersonalization + NSPrivacyCollectedDataTypePurposeAppFunctionality + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeDeviceID + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeAnalytics + NSPrivacyCollectedDataTypePurposeAppFunctionality + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + NSPrivacyCollectedDataTypePurposeProductPersonalization + + + + + diff --git a/Localytics-iOS-Latest/Localytics.xcframework/Info.plist b/Localytics-iOS-Latest/Localytics.xcframework/Info.plist deleted file mode 100644 index ff9e4af..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/Info.plist +++ /dev/null @@ -1,42 +0,0 @@ - - - - - AvailableLibraries - - - LibraryIdentifier - ios-arm64_armv7 - LibraryPath - Localytics.framework - SupportedArchitectures - - arm64 - armv7 - - SupportedPlatform - ios - - - LibraryIdentifier - ios-arm64_i386_x86_64-simulator - LibraryPath - Localytics.framework - SupportedArchitectures - - arm64 - i386 - x86_64 - - SupportedPlatform - ios - SupportedPlatformVariant - simulator - - - CFBundlePackageType - XFWK - XCFrameworkFormatVersion - 1.0 - - diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCampaignBase.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCampaignBase.h deleted file mode 100644 index ca97b5d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCampaignBase.h +++ /dev/null @@ -1,47 +0,0 @@ -// -// LLCampaignBase.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** An enum to define the specific channel that this campaign belongs to */ -typedef NS_ENUM(NSInteger, CampaignType) { - /** A value to specify that this campaign is an In-App campaign */ - CampaignTypeInApp, - /** A value to specify that this campaign is a Push campaign */ - CampaignTypePush, - /** A value to specify that this campaign is an Inbox campaign */ - CampaignTypeInbox, - /** A value to specify that this campaign is a Places campaign */ - CampaignTypePlaces -}; - -/** - * A base campaign class containing information relevant to all campaign types - */ -@interface LLCampaignBase : NSObject -// Make sure to override all properties in copyWithZone! - -/** - * The unique campaign id. - */ -@property (nonatomic, assign, readonly) NSInteger campaignId; - -/** - * The campaign name - */ -@property (nonatomic, copy, readonly, nonnull) NSString *name; - -/** - * The attributes associated with the campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *attributes; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCustomer.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCustomer.h deleted file mode 100644 index 801c62a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLCustomer.h +++ /dev/null @@ -1,92 +0,0 @@ -// -// LLCustomer.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A customer object builder used to set a customer's: - * - id - * - first name - * - last name - * - full name - * - email address - */ -@interface LLCustomerBuilder : NSObject - -/** - * Builder setter for customer's id - */ -@property (nonatomic, strong, nullable) NSString* customerId; - -/** - * Builder setter for customer's first name - */ - -@property (nonatomic, strong, nullable) NSString* firstName; -/** - * Builder setter for customer's last name - */ - -@property (nonatomic, strong, nullable) NSString* lastName; -/** - * Builder setter for customer's full name - */ -@property (nonatomic, strong, nullable) NSString* fullName; - -/** - * Builder setter for customer's email address - */ -@property (nonatomic, strong, nullable) NSString* emailAddress; - -@end - - -/** - * A customer object. A customer can have: - * - id - * - first name - * - last name - * - full name - * - email address - */ -@interface LLCustomer : NSObject - -/** - * Customer's id - */ -@property (nonatomic, strong, readonly, nullable) NSString* customerId; - -/** - * Customer's first name - */ -@property (nonatomic, strong, readonly, nullable) NSString* firstName; - -/** - * Customer's last name - */ -@property (nonatomic, strong, readonly, nullable) NSString* lastName; - -/** - * Customer's full name - */ -@property (nonatomic, strong, readonly, nullable) NSString* fullName; - -/** - * Customer's email address - */ -@property (nonatomic, strong, readonly, nullable) NSString* emailAddress; - -/** - * Constructor for a customer object using a customer builder - */ -+ (nullable instancetype)customerWithBlock:(nonnull void (^)(LLCustomerBuilder * __nonnull builder))block; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLGeofence.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLGeofence.h deleted file mode 100644 index 7f11768..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLGeofence.h +++ /dev/null @@ -1,24 +0,0 @@ -// -// LLGeofence.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A class representing a circular region - */ -@interface LLGeofence : LLRegion - -/** - * The Core Location circular region object associated with this region - */ -@property (nonatomic, copy, readonly, nonnull) CLCircularRegion *region; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppCampaign.h deleted file mode 100644 index 3f18ab7..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppCampaign.h +++ /dev/null @@ -1,70 +0,0 @@ -// -// LLInAppCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import -#import - -/** - * The campaign class containing information relevant to a single In-App campaign. - * - * @see LLWebViewCampaign - * @see LLCampaignBase - */ -@interface LLInAppCampaign : LLWebViewCampaign -// Make sure to override all properties in copyWithZone! - -/** - * The type of In-App message associated with this campaign. - */ -@property (nonatomic, assign, readonly) LLInAppMessageType type; - -/** - * Value indicating if the campaign has a responsive creative for various sizes. - */ -@property (nonatomic, assign, readonly) BOOL isResponsive; - -/** - * Value indicating the desired aspect ratio for presentation (only relevant for center campaigns). - */ -@property (nonatomic, assign, readonly) CGFloat aspectRatio; - -/** - * Value indicating the desired offset for presentation (only relevant for banner campaigns) - */ -@property (nonatomic, assign, readonly) CGFloat offset; - -/** - * Value indicating the desired background alpha for presentation (only relevant for center and fullscreen campaigns) - */ -@property (nonatomic, assign, readonly) CGFloat backgroundAlpha; - -/** - * Value indicating if the dismiss button is hidden - */ -@property (nonatomic, assign, getter=isDismissButtonHidden, readonly) BOOL dismissButtonHidden; - -/** - * Value indicating the location of the dismiss button (left or right) - */ -@property (nonatomic, assign, readonly) LLInAppMessageDismissButtonLocation dismissButtonLocation; - -/** - * Value indicating the name of the event that triggered the In-App campaign. - */ -@property (nonatomic, copy, readonly, nonnull) NSString *eventName; - -/** - * Value indicating the attributes on the event that triggered the In-App campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *eventAttributes; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppConfiguration.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppConfiguration.h deleted file mode 100644 index debf09a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInAppConfiguration.h +++ /dev/null @@ -1,89 +0,0 @@ -// -// LLInAppConfiguration.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@class UIImage; - -/** - * The In-App's configuration object used to define certain properties that can be modified on an In-App message. - */ -@interface LLInAppConfiguration : NSObject - -/** The location of the dismiss button on an In-App message */ -@property (nonatomic, assign) LLInAppMessageDismissButtonLocation dismissButtonLocation; -/** The image of the dismiss button on an In-App message */ -@property (nonatomic, strong, nullable) UIImage *dismissButtonImage; -/** The hidden state of the dismiss button on an In-App message */ -@property (nonatomic, assign) BOOL dismissButtonHidden; -/** - Set the aspect ratio for this In-App. The aspect ratio should be a float value representing a ratio of height to width (example 9:16 display is 0.56). - Accepted values must be greater than 0. This property is only relevant for Center and Banner In-App messages. - */ -@property (nonatomic, assign) CGFloat aspectRatio; - -/** - Set the aspect ratio for this In-App. The aspect ratio should be a float value representing a ratio of width to height (example 16:9 display is 1.77). - Accepted values must be greater than 0. This property is only relevant for Center and Banner In-App messages. - */ -@property (nonatomic, assign) CGFloat widthToHeightRatio; -/** The offset of the In-App msg. This property is only relevant for top or bottom banner In-App messages */ -@property (nonatomic, assign) CGFloat offset; -/** - * Set the background alpha for this in-app. The background alpha should be a float value - * representing the desired transparency for the backdrop of the creative. - * - * Accepted values must be greater than 0 and less than 1. - * - * This property is only relevant for center and full - * screen in-app Campaigns - * - * @param backgroundAlpha a float value greater than 0 and less than 1 - * representing the transparency of the campaign backdrop. - */ -@property (nonatomic, assign) CGFloat backgroundAlpha; -/** AutoHide Home Screen Indicator */ -@property (nonatomic, assign) BOOL autoHideHomeScreenIndicator; -/** The screen area covered by the In-app. - * NO - Within Safe Area - * YES - Covers Entire Screen and html needs to handle notch and screen curvature. - */ -@property (nonatomic, assign) BOOL notchFullScreen; - -/** The percentage of the in-app video that needs to be watched before sending a video event */ -@property(nonatomic, assign) CGFloat videoConversionPercentage; - -/** Returns whether this is a center In-App message. - @return YES if this is a center In-App message, NO otherwise - */ -- (BOOL)isCenterCampaign; -/** Returns whether this is a top banner In-App message. - @return YES if this is a top banner In-App message, NO otherwise - */ -- (BOOL)isTopBannerCampaign; -/** Returns whether this is a bottom banner In-App message. - @return YES if this is a bottom banner In-App message, NO otherwise - */ -- (BOOL)isBottomBannerCampaign; -/** Returns whether this is a full screen In-App message. - @return YES if this is a full screen In-App message, NO otherwise - */ -- (BOOL)isFullScreenCampaign; - -/** Set the image to be used for dimissing an In-App message by providing the name of the - image to be loaded and used - @param imageName The name of an image to be loaded and used for dismissing an In-App - message. By default the image is a circle with an 'X' in the middle of it - */ -- (void)setDismissButtonImageWithName:(nonnull NSString *)imageName; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxCampaign.h deleted file mode 100644 index 486b570..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxCampaign.h +++ /dev/null @@ -1,81 +0,0 @@ -// -// LLInboxCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -/** - * The campaign class containing information relevant to a single inbox campaign. - * - * @see LLWebViewCampaign - * @see LLCampaignBase - */ -@interface LLInboxCampaign : LLWebViewCampaign -// Make sure to override all properties in copyWithZone! - -/** - * The flag indicating whether the campaign has been read. - * - * Note: Changing this value will automatically update the inbox campaign record - * in the Localytics database. - */ -@property (nonatomic, assign, getter=isRead) BOOL read; - -/** - * The preview title text. - */ -@property (nonatomic, copy, readonly, nullable) NSString *titleText; - -/** - * The preview description text. - */ -@property (nonatomic, copy, readonly, nullable) NSString *summaryText; - -/** - * The remote url of the thumbnail. - */ -@property (nonatomic, copy, readonly, nullable) NSURL *thumbnailUrl; - -/** - * Value indicating if the campaign has a creative. - */ -@property (nonatomic, assign, readonly) BOOL hasCreative; - -/** - * The sort order of the campaign. - */ -@property (nonatomic, assign, readonly) NSInteger sortOrder; - -/** - * The received date of the campaign. - */ -@property (nonatomic, assign, readonly) NSTimeInterval receivedDate; - -/** - * The deep link of the campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSURL *deepLinkURL; - -/** - * True if this inbox campaign was created from a push campaign. - */ -@property (nonatomic, assign, readonly) BOOL isPushToInboxCampaign; - -@property (nonatomic, assign, readwrite) CGFloat videoConversionPercentage; - -/** - * True if this inbox campaign has been deleted. - */ -@property (nonatomic, assign, getter=isDeleted, readonly) BOOL deleted; - -- (void)delete; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxDetailViewController.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxDetailViewController.h deleted file mode 100644 index e2f7825..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxDetailViewController.h +++ /dev/null @@ -1,53 +0,0 @@ -// -// LLInboxDetailViewController.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -@class LLInboxCampaign; - -/** - * UIViewController class that displays an inbox campaign's full creative. This class also handles tagging - * impression events when a call to action is tapped within the creative or when the UIViewController is - * dismissed. - * - * Customization options: - * - Error view, @see errorView - * - * @see LLInboxViewController - */ -@interface LLInboxDetailViewController : UIViewController - -/** - * The inbox campaign being displayed - */ -@property (nonatomic, strong, readonly, nonnull) LLInboxCampaign *campaign; - -/** - * The UIView to show when the full creative fails to load. If this property is not set, a gray 'X' will - * be shown in the center of the view. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxDetailViewController. - */ -@property (nonatomic, strong, nullable) UIView *creativeLoadErrorView; - -/** - * Flag indicating whether delete should be implemented as a navigation item on the detail view controller. - */ -@property (nonatomic, assign) BOOL deleteInNavBar; - -/** - * The string to use to indicate the "Delete" action to the user. The default value is "Delete" - */ -@property (nonatomic, strong, nullable) NSString *deleteActionText; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxViewController.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxViewController.h deleted file mode 100644 index cd0372c..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLInboxViewController.h +++ /dev/null @@ -1,150 +0,0 @@ -// -// LLInboxViewController.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@protocol LLInboxCampaignsRefreshingDelegate -@optional - -- (void)localyticsDidBeginRefreshingInboxCampaigns; -- (void)localyticsDidFinishRefreshingInboxCampaigns; - -@end - -/** - * UIViewController class that loads inbox campaigns and displays them in a UITableView. - * This class also handles marking inbox campaigns as read and displaying the inbox - * campaign's full creative when it is tapped by pushing an LLInboxDetailViewController - * onto the UINavigationController stack. - * - * By default this class uses custom UITableViewCells which include an unread indicator, title text, - * summary text (when available), thumbnail image (when available), and created time text. - * - * Customization options: - * - Empty campaigns view, @see property emptyCampaignsView - * - Show UIActivityIndicatorView while loading campaigns, @see property showsActivityIndicatorView - * - UITableViewCells, override tableView:cellForRowAtIndexPath: - * - Full creative display, override tableView:didSelectRowAtIndexPath:, Note: You must also handle - * setting the LLInboxCampaign to be read and checking the existense of the creativeUrl property of - * the LLInboxCampaign object. - * - Implement delete using a swipe action @see property enableSwipeDelete or in the navigation bar from - * the detail view @see property enableDetailViewDelete - * - * @see LLInboxDetailViewController - */ -@interface LLInboxViewController : UIViewController - -/** - * The UITableView that shows the inbox campaigns. - */ -@property (nonatomic, strong, nonnull) UITableView *tableView; - -/** - * The NSArray of LLInboxCampaigns backing the UITableView - */ -@property (nonatomic, strong, nullable) NSArray *tableData; - -/** - * The UIView to show when there are no inbox campaigns to display. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxViewController. - */ -@property (nonatomic, strong, nonnull) UIView *emptyCampaignsView; - -/** - * Flag indicating whether a UIActivityIndicatorView should be shown will campaigns are loading. - */ -@property (nonatomic, assign) BOOL showsActivityIndicatorView; - -/** - * Flag indicating whether delete should be implemented as a swipe action on the list view - */ -@property (nonatomic, assign) BOOL enableSwipeDelete; - -/** - * The string to use to indicate the "Delete" action to the user. The default value is "Delete" - */ -@property (nonatomic, strong, nullable) NSString *deleteActionText; - -/** - * Flag indicating whether delete should be implemented as a navigation item on the detail view controller. - */ -@property (nonatomic, assign) BOOL enableDetailViewDelete; - -/** - * Flag indicating whether thumbnail images are automatically downloaded and loading into LLInboxThumbnailCell. - * Defaults to YES. Set this property to NO to manually manage thumbnail downloading and caching (such as through - * a 3rd party networking library). - */ -@property (nonatomic, assign) BOOL downloadsThumbnails; - -/** - * The font of the UITableViewCell textLabel. Default is 16 point system bold. - */ -@property (nonatomic, strong, nonnull) UIFont *textLabelFont; - -/** - * The color of the UITableViewCell textLabel. Default is black. - */ -@property (nonatomic, strong, nonnull) UIColor *textLabelColor; - -/** - * The font of the UITableViewCell detailTextLabel. Default is 14 point system. - */ -@property (nonatomic, strong, nonnull) UIFont *detailTextLabelFont; - -/** - * The color of the UITableViewCell detailTextLabel. Default is black. - */ -@property (nonatomic, strong, nonnull) UIColor *detailTextLabelColor; - -/** - * The font of the UITableViewCell timeTextLabel. Default is 10 point system. - */ -@property (nonatomic, strong, nonnull) UIFont *timeTextLabelFont; - -/** - * The color of the UITableViewCell timeTextLabel. Default is gray. - */ -@property (nonatomic, strong, nonnull) UIColor *timeTextLabelColor; - -/** - * The color of the UITableViewCell unread indicator. Default is #007AFF. - */ -@property (nonatomic, strong, nonnull) UIColor *unreadIndicatorColor; - -/** - * The color of the UITablviewCell background - */ -@property (nonatomic, strong, nonnull) UIColor *cellBackgroundColor; - -/** - * The UIView to show when a creative fails to load in a detail view. This property is used to set the - * creativeLoadErrorView of LLInboxDetailViewControllers created when the user opens a campaign. - * If this property is not set, a gray 'X' will be shown in the center of the view. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxDetailViewController. - */ -@property (nonatomic, strong, nullable) UIView *creativeLoadErrorView; - -/** - * Returns the inbox campaign for an index path (useful for overriding tableView:cellForRowAtIndexPath:) - * - * @return An LLInboxCampaign object for the index path. - */ -- (nullable LLInboxCampaign *)campaignForRowAtIndexPath:(nonnull NSIndexPath *)indexPath; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLMarketingWebViewHandler.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLMarketingWebViewHandler.h deleted file mode 100644 index 120072b..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLMarketingWebViewHandler.h +++ /dev/null @@ -1,50 +0,0 @@ -#import - -@class LLWebViewCampaign; -@protocol LLLocalyticsDelegate; - -@protocol LLMarketingWebViewHandlerDelegate - -- (void)handlerDidFinishLoad; -- (void)handlerDidFailLoadWithError:(nullable NSError *)error; - -@optional -- (void)didHandleCloseRequest; - -@end - -@interface LLMarketingWebViewHandlerBuilder : NSObject - -@property (nonatomic, strong, nullable) WKWebView *webView; -@property (nonatomic, strong, nullable) LLWebViewCampaign *campaign; -@property (nonatomic, assign) BOOL openCustomURLSchemas; -@property (nonatomic, assign) BOOL loadUnknownURLSchemas; -@property (nonatomic, assign) CGFloat videoConversionPercentage; -@property (nonatomic, assign, getter=isTestModeEnabled) BOOL testModeEnabled; -@property (nonatomic, weak, nullable) id localyticsDelegate; -@property (nonatomic, assign, nonnull) NSString *creativeFilePath; - -+ (nonnull WKWebViewConfiguration *)webViewConfiguration:(nullable LLWebViewCampaign *)campaign - localyticsDelegate:(nonnull id)localyticsDelegate - andViewportWidth:(CGFloat)viewportWidth - withViewportFit:(nullable NSString *)viewportFit - videoConversionPercentage:(CGFloat)videoConversionPercentage; - -@end - -@interface LLMarketingWebViewHandler : NSObject - -@property (nonatomic, strong) WKWebView * __nullable webView; -@property (nonatomic, strong) __nullable id delegate; -//exposed for wrappers -@property (nonatomic, strong, nullable) LLWebViewCampaign *campaign; - -+ (nullable instancetype)marketingWebViewWithBlock:(nonnull void (^)(LLMarketingWebViewHandlerBuilder * __nonnull builder))block; - -- (BOOL)loadCreative; -- (void)tagMarketingActionForURL:(nonnull NSURL *)url andQueryParams:(nonnull NSDictionary *)queryParams; -- (void)tagMarketingDismissAction; -- (BOOL)creativeHtmlFileExists; -- (void)executeJs:(nonnull NSString*)js; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLPlacesCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLPlacesCampaign.h deleted file mode 100644 index 2880394..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLPlacesCampaign.h +++ /dev/null @@ -1,60 +0,0 @@ -// -// LLPlacesCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@class LLRegion; - -/** - * The campaign class containing information relevant to a single places campaign. - * - * @see LLCampaignBase - */ -@interface LLPlacesCampaign : LLCampaignBase -// Make sure to override all properties in copyWithZone! - -/** - * The push message - */ -@property (nonatomic, copy, readonly, nonnull) NSString *message; - -/** - * The sound filename of the UILocalNotification - */ -@property (nonatomic, copy, readonly, nullable) NSString *soundFilename; - -/** - * The region object associated with this campaign - */ -@property (nonatomic, copy, readonly, nonnull) LLRegion *region; - -/** - * The event which triggered this campaign - */ -@property (nonatomic, assign, readonly) LLRegionEvent event; - -/** - * The category for the local notification - */ -@property (nonatomic, copy, readonly, nullable) NSString *category; - -/** - * The attachment URL for the UNNotificationAttachment - */ -@property (nonatomic, copy, readonly, nullable) NSString *attachmentURL; - -/** - * The attachment URL type for the UNNotificationAttachment - */ -@property (nonatomic, copy, readonly, nullable) NSString *attachmentType; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLRegion.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLRegion.h deleted file mode 100644 index e925396..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLRegion.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// LLRegion.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -/** - * A base region class containing information relevant to all region types - */ -@interface LLRegion : NSObject - -/** - * The name of the region - */ -@property (nonatomic, copy, readonly, nullable) NSString *name; - -/** - * The attributes associated with the region - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *attributes; - -/** - * The Core Location region object associated with this region - */ -@property (nonatomic, copy, readonly, nonnull) CLRegion *region; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLWebViewCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLWebViewCampaign.h deleted file mode 100644 index 70728c8..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LLWebViewCampaign.h +++ /dev/null @@ -1,28 +0,0 @@ -// -// LLWebViewCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A base campaign class containing information relevant to campaigns which - * include a web component. - * - * @see LLCampaignBase - */ -@interface LLWebViewCampaign : LLCampaignBase -// Make sure to override all properties in copyWithZone! - -/** - * The file path on disk of the creative associated with this campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSString *creativeFilePath; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics-Framework.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics-Framework.h deleted file mode 100644 index 7b2002d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics-Framework.h +++ /dev/null @@ -1,20 +0,0 @@ -// -// Localytics-Framework.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -//! Project version number for Localytics. -FOUNDATION_EXPORT double LocalyticsVersionNumber; - -//! Project version string for Localytics. -FOUNDATION_EXPORT const unsigned char LocalyticsVersionString[]; - -#import diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics.h deleted file mode 100644 index dd0e67d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/Localytics.h +++ /dev/null @@ -1,1667 +0,0 @@ -// -// Localytics.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import -#import -#import -/* - Analytics Delegate -*/ -@protocol LLAnalyticsDelegate; - -#if !TARGET_OS_TV - -#import -#import -#import -#import -#import -#import -#import -#import -#import -#import -#import - -@protocol LLMessagingDelegate; -@protocol LLCallToActionDelegate; -@protocol LLLocationDelegate; - -@class WKWebViewConfiguration; -@class UNMutableNotificationContent; -#define LOCALYTICS_LIBRARY_VERSION @"6.2.9" //iOS version - -#else - -#define LOCALYTICS_LIBRARY_VERSION @"1.0.2" //tvOS version - -#endif - - -@protocol Localytics -#if TARGET_OS_TV - -#endif - -#pragma mark - SDK Integration -/** --------------------------------------------------------------------------------------- - * @name Localytics SDK Integration - * --------------------------------------------------------------------------------------- - */ - -/** Auto-integrates the Localytic SDK into the application. - - Use this method to automatically integrate the Localytics SDK in a single line of code. Automatic - integration is accomplished by proxying the AppDelegate and "inserting" a Localytics AppDelegate - behind the applications AppDelegate. The proxy will first call the applications AppDelegate and - then call the Localytics AppDelegate. - - @param appKey The unique key for each application generated at www.localytics.com - @param localyticsOptions A dictionary containing intervals for uploading data based on connection type. - If set to nil, defaults will be used. - @param launchOptions The launchOptions provided by application:DidFinishLaunchingWithOptions: - - @see LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS - - @Version SDK5.0 - */ -+ (void)autoIntegrate:(nonnull NSString *)appKey withLocalyticsOptions:(nullable NSDictionary *)localyticsOptions launchOptions:(nullable NSDictionary *)launchOptions NS_AVAILABLE_IOS(9_0); - -/** Manually integrate the Localytic SDK into the application. - - Use this method to manually integrate the Localytics SDK. The developer still has to make sure to - open and close the Localytics session as well as call upload to ensure data is uploaded to - Localytics - - @param appKey The unique key for each application generated at www.localytics.com - @param localyticsOptions A dictionary containing intervals for uploading data based on connection type. - If set to nil, defaults will be used. - @see openSession - @see closeSession - @see upload - @see LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS - - @Version SDK5.0 - */ -+ (void)integrate:(nonnull NSString *)appKey withLocalyticsOptions:(nullable NSDictionary *)localyticsOptions NS_AVAILABLE_IOS(9_0); - -/** Opens the Localytics session. - The session time as presented on the website is the time between open and the - final close so it is recommended to open the session as early as possible, and close - it at the last moment. It is recommended that this call be placed in applicationDidBecomeActive. -
- If for any reason this is called more than once every subsequent open call will be ignored. - - Resumes the Localytics session. When the App enters the background, the session is - closed and the time of closing is recorded. When the app returns to the foreground, the session - is resumed. If the time since closing is greater than BACKGROUND_SESSION_TIMEOUT, (15 seconds - by default) a new session is created, and uploading is triggered. Otherwise, the previous session - is reopened. - - * @Version SDK3.0 - */ -+ (void)openSession NS_AVAILABLE_IOS(9_0); - -/** Closes the Localytics session. This should be called in - applicationWillResignActive. -
- If close is not called, the session will still be uploaded but no - events will be processed and the session time will not appear. This is - because the session is not yet closed so it should not be used in - comparison with sessions which are closed. - - @Version SDK3.0 - */ -+ (void)closeSession NS_AVAILABLE_IOS(9_0); - -/** Creates a low priority thread which uploads any Localytics data already stored - on the device. This should be done early in the process life in order to - guarantee as much time as possible for slow connections to complete. It is also reasonable - to upload again when the application is exiting because if the upload is cancelled the data - will just get uploaded the next time the app comes up. - - @Version SDK3.0 - */ -+ (void)upload NS_AVAILABLE_IOS(9_0); - -/** - Halt the uploading of Analytics and Profiles data to the Localytics servers. - Re-enabling the upload of data will cause an immediate upload. - - @Version SDK5.1 - @param pause if set to true, all data uploading will be halted. If false, data uploading will resume as normal. - */ - -+ (void)pauseDataUploading:(BOOL)pause NS_AVAILABLE_IOS(9_0); - -#pragma mark - Event Tagging -/** --------------------------------------------------------------------------------------- - * @name Event Tagging - * --------------------------------------------------------------------------------------- - */ - -/** Tag an event - @param eventName The name of the event which occurred. - @see tagEvent:attributes:customerValueIncrease: - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName NS_AVAILABLE_IOS(9_0); - -/** Tag an event with attributes - @param eventName The name of the event which occurred. - @param attributes An object/hash/dictionary of key-value pairs, contains - contextual data specific to the event. - @see tagEvent:attributes:customerValueIncrease: - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** Allows a session to tag a particular event as having occurred. For - example, if a view has three buttons, it might make sense to tag - each button click with the name of the button which was clicked. - For another example, in a game with many levels it might be valuable - to create a new tag every time the user gets to a new level in order - to determine how far the average user is progressing in the game. -
- Tagging Best Practices -
    -
  • DO NOT use tags to record personally identifiable information.
    • -
  • The best way to use tags is to create all the tag strings as predefined - constants and only use those. This is more efficient and removes the risk of - collecting personal information.
    • -
  • Do not set tags inside loops or any other place which gets called - frequently. This can cause a lot of data to be stored and uploaded.
    • -
-
- See the tagging guide at: http://docs.localytics.com/dev/ios.html#events-ios - @param eventName The name of the event which occurred. - @param attributes (Optional) An object/hash/dictionary of key-value pairs, contains - contextual data specific to the event. - @param customerValueIncrease (Optional) Numeric value, added to customer lifetime value. - Integer expected. Try to use lowest possible unit, such as cents for US currency. - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName attributes:(nullable NSDictionary *)attributes customerValueIncrease:(nullable NSNumber *)customerValueIncrease NS_AVAILABLE_IOS(9_0); - -#pragma mark - Standard Event Tagging -/** --------------------------------------------------------------------------------------- - * @name Standard Event Tagging - * --------------------------------------------------------------------------------------- - */ - -/** - * A standard event to tag a single item purchase event (after the action has occurred) - * - * @param itemName The name of the item purchased (optional, can be null) - * @param itemId A unique identifier of the item being purchased, such as a SKU (optional, can be null) - * @param itemType The type of item (optional, can be null) - * @param itemPrice The price of the item (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency. - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagPurchased:(nullable NSString *)itemName itemId:(nullable NSString *)itemId itemType:(nullable NSString *)itemType itemPrice:(nullable NSNumber *)itemPrice attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the addition of a single item to a cart (after the action has occurred) - * - * @param itemName The name of the item purchased (optional, can be null) - * @param itemId A unique identifier of the item being purchased, such as a SKU (optional, can be null) - * @param itemType The type of item (optional, can be null) - * @param itemPrice The price of the item (optional, can be null). Will NOT be added to customer lifetime value. - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagAddedToCart:(nullable NSString *)itemName itemId:(nullable NSString *)itemId itemType:(nullable NSString *)itemType itemPrice:(nullable NSNumber *)itemPrice attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the start of the checkout process (after the action has occurred) - * - * @param totalPrice The total price of all the items in the cart (optional, can be null). Will NOT be added to customer lifetime value. - * @param itemCount Total count of items in the cart (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagStartedCheckout:(nullable NSNumber *)totalPrice itemCount:(nullable NSNumber *)itemCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the conclusions of the checkout process (after the action has occurred) - * - * @param totalPrice The total price of all the items in the cart (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency. - * @param itemCount Total count of items in the cart (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCompletedCheckout:(nullable NSNumber *)totalPrice itemCount:(nullable NSNumber *)itemCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the viewing of content (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagContentViewed:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a search event (after the action has occurred) - * - * @param queryText The query user for the search (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param resultCount The number of results returned by the query (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagSearched:(nullable NSString *)queryText contentType:(nullable NSString *)contentType resultCount:(nullable NSNumber *)resultCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a share event (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param methodName The method by which the content was shared such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagShared:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the rating of content (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param rating A rating of the content (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagContentRated:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType rating:(nullable NSNumber *)rating attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the registration of a user (after the action has occurred) - * - * @param customer An object providing information about the customer that registered (optional, can be null) - * @param methodName The method by which the user was registered such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerRegistered:(nullable LLCustomer *)customer methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the logging in of a user (after the action has occurred) - * - * @param customer An object providing information about the customer that logged in (optional, can be null) - * @param methodName The method by which the user was logged in such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerLoggedIn:(nullable LLCustomer *)customer methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the logging out of a user (after the action has occurred) - * - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerLoggedOut:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the invitation of a user (after the action has occured) - * - * @param methodName The method by which the user was invited such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagInvited:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -#pragma mark - Tag Screen Method - -/** Allows tagging the flow of screens encountered during the session. - @param screenName The name of the screen - - @Version SDK3.0 - */ -+ (void)tagScreen:(nonnull NSString *)screenName NS_AVAILABLE_IOS(9_0); - -#pragma mark - Custom Dimensions -/** --------------------------------------------------------------------------------------- - * @name Custom Dimensions - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a custom dimension. Custom dimensions are dimensions - which contain user defined data unlike the predefined dimensions such as carrier, model, and country. - Once a value for a custom dimension is set, the device it was set on will continue to upload that value - until the value is changed. To clear a value pass nil as the value. - The proper use of custom dimensions involves defining a dimension with less than ten distinct possible - values and assigning it to one of the four available custom dimensions. Once assigned this definition should - never be changed without changing the App Key otherwise old installs of the application will pollute new data. - @param value The value to set the custom dimension to - @param dimension The dimension to set the value of - @see valueForCustomDimension: - - @Version SDK3.0 - */ -+ (void)setValue:(nullable NSString *)value forCustomDimension:(NSUInteger)dimension NS_AVAILABLE_IOS(9_0); - -/** Gets the custom value for a given dimension. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @param dimension The custom dimension to return a value for - @return The current value for the given custom dimension - @see setValue:forCustomDimension: - - @Version SDK3.0 - */ -+ (nullable NSString *)valueForCustomDimension:(NSUInteger)dimension NS_AVAILABLE_IOS(9_0); - -#pragma mark - Identifiers -/** --------------------------------------------------------------------------------------- - * @name Identifiers - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a custom identifier. Identifiers are a form of key/value storage - which contain custom user data. Identifiers might include things like email addresses, - customer IDs, twitter handles, and facebook IDs. Once a value is set, the device it was set - on will continue to upload that value until the value is changed. - To delete a property, pass in nil as the value. - @param value The value to set the identifier to. To delete a propert set the value to nil - @param identifier The name of the identifier to have it's value set - @see valueForIdentifier: - - @Version SDK3.0 - */ -+ (void)setValue:(nullable NSString *)value forIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Gets the identifier value for a given identifier. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @param identifier The identifier to return a value for - @return The current value for the given identifier - @see setValue:forCustomDimension: - - @Version SDK3.0 - */ -+ (nullable NSString *)valueForIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Set the identifier for the customer. This value is used when setting profile attributes, - targeting users for push and mapping data exported from Localytics to a user. - @param customerId The value to set the customer identifier to - - @Version SDK3.0 - */ -+ (void)setCustomerId:(nullable NSString *)customerId NS_AVAILABLE_IOS(9_0); - -/** Set the identifier for the customer. This value is used when setting profile attributes, - targeting users for push and mapping data exported from Localytics to a user. - Additionally this will set the appropriate data collection state for the the user. - @param customerId The value to set the customer identifier to - @param optedOut If the user has consented to data collection - @see setCustomerId: - @see setPrivacyOptedOut: - - @Version SDK5.1 - */ -+ (void)setCustomerId:(nullable NSString *)customerId privacyOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Gets the customer id. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @return The current value for customer id - - @Version SDK3.1.0 - */ -+ (nullable NSString *)customerId NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Profile -/** --------------------------------------------------------------------------------------- - * @name Profile - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a profile attribute. - @param value The value to set the profile attribute to. value can be one of the following: NSString, - NSNumber(long & int), NSDate, NSArray of Strings, NSArray of NSNumbers(long & int), NSArray of Date, - nil. Passing in a 'nil' value will result in that attribute being deleted from the profile - @param attribute The name of the profile attribute to be set - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)setValue:(nonnull id)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Sets the value of a profile attribute (scope: Application). - @param value The value to set the profile attribute to. value can be one of the following: NSString, - NSNumber(long & int), NSDate, NSArray of Strings, NSArray of NSNumbers(long & int), NSArray of Date, - nil. Passing in a 'nil' value will result in that attribute being deleted from the profile - @param attribute The name of the profile attribute to be set - - @Version SDK3.0 - */ -+ (void)setValue:(nonnull id)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Adds values to a profile attribute that is a set - @param values The value to be added to the profile attributes set. - @param attribute The name of the profile attribute to have it's set modified - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)addValues:(nonnull NSArray *)values toSetForProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Adds values to a profile attribute that is a set (scope: Application). - @param values The value to be added to the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - - @Version SDK3.0 - */ -+ (void)addValues:(nonnull NSArray *)values toSetForProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Removes values from a profile attribute that is a set - @param values The value to be removed from the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)removeValues:(nonnull NSArray *)values fromSetForProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Removes values from a profile attribute that is a set (scope: Application). - @param values The value to be removed from the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - - @Version SDK3.0 - */ -+ (void)removeValues:(nonnull NSArray *)values fromSetForProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Increment the value of a profile attribute. - @param value An NSInteger to be added to an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value incremented - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)incrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Increment the value of a profile attribute (scope: Application). - @param value An NSInteger to be added to an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value incremented - - @Version SDK3.0 - */ -+ (void)incrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Decrement the value of a profile attribute. - @param value An NSInteger to be subtracted from an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value decremented - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)decrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Decrement the value of a profile attribute (scope: Application). - @param value An NSInteger to be subtracted from an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value decremented - - @Version SDK3.0 - */ -+ (void)decrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Delete a profile attribute - @param attribute The name of the attribute to be deleted - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)deleteProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Delete a profile attribute (scope: Application) - @param attribute The name of the attribute to be deleted - - @Version SDK3.0 - */ -+ (void)deleteProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's email as both a profile attribute and - as a customer identifier (scope: Organization) - @param email Customer's email - - @Version SDK3.3.0 - */ -+ (void)setCustomerEmail:(nullable NSString *)email NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's first name as both a profile attribute and - as a customer identifier (scope: Organization) - @param firstName Customer's first name - - @Version SDK3.3.0 - */ -+ (void)setCustomerFirstName:(nullable NSString *)firstName NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's last name as both a profile attribute and - as a customer identifier (scope: Organization) - @param lastName Customer's last name - - @Version SDK3.3.0 - */ -+ (void)setCustomerLastName:(nullable NSString *)lastName NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's full name as both a profile attribute and - as a customer identifier (scope: Organization) - @param fullName Customer's full name - - @Version SDK3.3.0 - */ -+ (void)setCustomerFullName:(nullable NSString *)fullName NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Developer Options -/** --------------------------------------------------------------------------------------- - * @name Developer Options - * --------------------------------------------------------------------------------------- - */ - -/** - * Customize the behavior of the SDK by setting custom values for various options. - * In each entry, the key specifies the option to modify, and the value specifies what value - * to set the option to. Options can be restored to default by passing in a value of NSNull, - * or an empty string for values with type NSString. - * @param options The dictionary of options and values to modify - * - * @Version SDK4.0 - */ -+ (void)setOptions:(nullable NSDictionary *)options NS_AVAILABLE_IOS(9_0); - -/** Returns whether the Localytics SDK is set to emit logging information - @return YES if logging is enabled, NO otherwise - - @Version SDK3.0 - */ -+ (BOOL)isLoggingEnabled NS_AVAILABLE_IOS(9_0); - -/** Set whether Localytics SDK should emit logging information. By default the Localytics SDK - is set to not to emit logging information. It is recommended that you only enable logging - for debugging purposes. - @param loggingEnabled Set to YES to enable logging or NO to disable it - - @Version SDK3.0 - */ -+ (void)setLoggingEnabled:(BOOL)loggingEnabled NS_AVAILABLE_IOS(9_0); - -/** Tell the Localytics SDK to keep a copy of all logs in a file on disk. - It is recommended that you only enable logging for debugging purposes. - - @Version SDK5.0 - */ -+ (void)redirectLoggingToDisk NS_AVAILABLE_IOS(9_0); - -/** Returns whether or not the application will collect user data. - @return YES if the user is opted out, NO otherwise. Default is NO - @see setOptedOut: - - @Version SDK3.0 - */ -+ (BOOL)isOptedOut NS_AVAILABLE_IOS(9_0); - -/** Allows the application to control whether or not it will collect user data. - Even if this call is used, it is necessary to continue calling upload(). No new data will be - collected, so nothing new will be uploaded but it is necessary to upload an event telling the - server this user has opted out. - @param optedOut YES if the user is opted out, NO otherwise. - @see isOptedOut - - @Version SDK3.0 - */ -+ (void)setOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Returns whether or not the application will collect user data. - @return YES if the user is opted out, NO otherwise. Default is NO - @see setPrivacyOptedOut: - - @Version SDK5.1 - */ -+ (BOOL)isPrivacyOptedOut NS_AVAILABLE_IOS(9_0); - -/** Sets the Localytics opt-out state for this application. This call is not necessary and is provided for people who wish to - allow their users the ability to opt out of data collection. It can be called at any time. Passing true causes all further - data collection to stop, and a profile attribute will be set causing a deletion of data request to be made for Localytics - in line with the GDPR standard. - There are very serious implications to the quality of your data when providing an opt out option. For example, users who - have opted out will appear as never returning, causing your new/returning chart to skew.
- As a side effect of protecting a user's data, the SDK will internally ensure that ADID's are - no longer appended to the url's of In-App and Inbox call to action links. - @param optedOut YES if the user is opted out, NO otherwise. - @see isPrivacyOptedOut - - @Version SDK5.1 - */ -+ (void)setPrivacyOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Returns the install id - @return the install id as an NSString - - @Version SDK3.0 - */ -+ (nullable NSString *)installId NS_AVAILABLE_IOS(9_0); - -/** Returns the version of the Localytics SDK - @return the version of the Localytics SDK as an NSString - - @Version SDK3.0 - */ -+ (nonnull NSString *)libraryVersion NS_AVAILABLE_IOS(9_0); - -/** Returns the app key currently set in Localytics - @return the app key currently set in Localytics as an NSString - - @Version SDK3.0 - */ -+ (nullable NSString *)appKey NS_AVAILABLE_IOS(9_0); - -/** Returns whether the Localytics SDK is currently in test mode or not. When in test mode - a small Localytics tab will appear on the left side of the screen which enables a developer - to see/test all the campaigns currently available to this customer. - @return YES if test mode is enabled, NO otherwise - - @Version SDK3.0 - */ -+ (BOOL)isTestModeEnabled NS_AVAILABLE_IOS(9_0); - -/** Set whether Localytics SDK should enter test mode or not. When set to YES the a small - Localytics tab will appear on the left side of the screen, enabling a developer to see/test - all campaigns currently available to this customer. - Setting testModeEnabled to NO will cause Localytics to exit test mode, if it's currently - in it. - @param enabled Set to YES to enable test mode, NO to disable test mode - - @Version SDK4.0 - */ -+ (void)setTestModeEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** - Enter live device logging mode. - - @Version SDK5.5 - */ -+ (void)enableLiveDeviceLogging NS_AVAILABLE_IOS(9_0); - -#pragma mark - Permission Prompts -/** - Request IDFA Permissions - - @Version SDK6.1 - */ -+ (BOOL)requestAdvertisingIdentifierPrompt NS_AVAILABLE_IOS(14_0); - -/** - Get IDFA Permission status - - @Version SDK6.1 - */ -+ (LLAdIdStatus)advertisingIdentifierStatus NS_AVAILABLE_IOS(14_0); - -#pragma mark - Analytics Delegate -/** --------------------------------------------------------------------------------------- - * @name Analytics Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set an Analytics delegate - @param delegate An object implementing the LLAnalyticsDelegate protocol. - @see LLAnalyticsDelegate - - @Version SDK3.0 - */ -+ (void)setAnalyticsDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Stores the user's location. This will be used in all event and session calls. - If your application has already collected the user's location, it may be passed to Localytics - via this function. This will cause all events and the session close to include the location - information. It is not required that you call this function. - @param location The user's location. - - @Version SDK3.0 - */ -+ (void)setLocation:(CLLocationCoordinate2D)location NS_AVAILABLE_IOS(9_0); - -#if !TARGET_OS_TV - -#pragma mark - Push -/** --------------------------------------------------------------------------------------- - * @name Push - * --------------------------------------------------------------------------------------- - */ - -/** Returns the device's APNS token if one has been set via setPushToken: previously. - @return The device's APNS token if one has been set otherwise nil - @see setPushToken: - - @Version SDK3.0 - */ -+ (nullable NSString *)pushToken NS_AVAILABLE_IOS(9_0); - -/** Stores the device's APNS token. This will be used in all event and session calls. - @param pushToken The devices APNS token returned by application:didRegisterForRemoteNotificationsWithDeviceToken: - @see pushToken - - @Version SDK3.0 - */ -+ (void)setPushToken:(nullable NSData *)pushToken NS_AVAILABLE_IOS(9_0); - -/** Used to record performance data for notifications, both Localytics Push Received and Push Opened. - With the introduction of UserNotifications in iOS 10, this method has been deprecated in favor of calling - handleNotificationReceived: for push received reporting and didReceiveNotificationResponseWithUserInfo: for push opened reporting. - @param notificationInfo The dictionary from either didFinishLaunchingWithOptions, didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - - @Version SDK4.0 - */ -+ (void)handleNotification:(nonnull NSDictionary *)notificationInfo NS_DEPRECATED_IOS(9_0, 10_0); - -/** Used to record performance data for notifications - @param notificationInfo The dictionary from either didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - - @Version SDK5.5 - */ -+ (void)handleNotificationReceived:(nonnull NSDictionary *)notificationInfo NS_AVAILABLE_IOS(10_0); - - -/** Used to record performance data for notifications with action identifiers - @param notificationInfo The dictionary from either didFinishLaunchingWithOptions, didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - @param identifier The specific notification action associated with the opened push notification. - - @Version SDK4.4.0 - */ -+ (void)handleNotification:(nonnull NSDictionary *)notificationInfo withActionIdentifier:(nullable NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Use to record performance data for notifications when using UNUserNotificationCenterDelegate - @param userInfo The UNNotificationResponse's userInfo retrieved by calling response.notification.request.content.userInfo - - @Version SDK4.1.0 - */ -+ (void)didReceiveNotificationResponseWithUserInfo:(nonnull NSDictionary *)userInfo NS_AVAILABLE_IOS(10_0); - -/** Use to record performance data for notifications when using UNUserNotificationCenterDelegate and a specific notification action was selected. - @param userInfo The UNNotificationResponse's userInfo retrieved by calling response.notification.request.content.userInfo - @param identifier The UNNotificationResponse's actionIdentifier retrieved by calling response.actionIdentifier - - @Version SDK4.4.0 - */ -+ (void)didReceiveNotificationResponseWithUserInfo:(nonnull NSDictionary *)userInfo andActionIdentifier:(nullable NSString *)identifier NS_AVAILABLE_IOS(10_0); - -/** Used to notify the Localytics SDK that notification settings have changed - - * @Version SDK5.0 - */ -+ (void)didRegisterUserNotificationSettings NS_AVAILABLE_IOS(9_0); - -/** Used to notify the Localytics SDK that user notification authorization has changed - * - * @param options The options used to request notification authorization - * @param granted The user's response to the notification request. - * @Version SDK4.1.0 - */ -+ (void)didRequestUserNotificationAuthorizationWithOptions:(NSUInteger)options granted:(BOOL)granted NS_AVAILABLE_IOS(9_0); - -#pragma mark - In-App Message -/** --------------------------------------------------------------------------------------- - * @name In-App Message - * --------------------------------------------------------------------------------------- - */ - -/** - @param url The URL to be handled - @return YES if the URL was successfully handled or NO if the attempt to handle the - URL failed. - - * @Version SDK3.0 - */ -+ (BOOL)handleTestModeURL:(nonnull NSURL *)url NS_AVAILABLE_IOS(9_0); - -/** Set the image to be used for dimissing an In-App message - @param image The image to be used for dismissing an In-App message. By default this is a - circle with an 'X' in the middle of it - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonImage:(nullable UIImage *)image NS_AVAILABLE_IOS(9_0); - -/** Set the image to be used for dimissing an In-App message by providing the name of the - image to be loaded and used - @param imageName The name of an image to be loaded and used for dismissing an In-App - message. By default the image is a circle with an 'X' in the middle of it - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonImageWithName:(nullable NSString *)imageName NS_AVAILABLE_IOS(9_0); - -/** Set the location of the dismiss button on an In-App msg - @param location The location of the button (left or right) - @see LLInAppMessageDismissButtonLocation - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonLocation:(LLInAppMessageDismissButtonLocation)location NS_AVAILABLE_IOS(9_0); - -/** Returns the location of the dismiss button on an In-App msg - @return LLInAppMessageDismissButtonLocation - @see LLInAppMessageDismissButtonLocation - - @Version SDK3.0 - */ -+ (LLInAppMessageDismissButtonLocation)inAppMessageDismissButtonLocation NS_AVAILABLE_IOS(9_0); - -/** Set the dismiss button hidden state on an In-App message - * @param hidden The hidden state of the dismiss button - * - * @Version SDK4.3.0 - */ -+ (void)setInAppMessageDismissButtonHidden:(BOOL)hidden NS_AVAILABLE_IOS(9_0); - -/** - Trigger an In-App message - - @param triggerName The name of the In-App message trigger - - @Version SDK3.0 - */ -+ (void)triggerInAppMessage:(nonnull NSString *)triggerName NS_AVAILABLE_IOS(9_0); - -/** - Trigger an In-App message - - @param triggerName The name of the In-App message trigger - @param attributes The attributes associated with the In-App triggering event - - @Version SDK3.0 - */ -+ (void)triggerInAppMessage:(nonnull NSString *)triggerName withAttributes:(nonnull NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - Trigger campaigns as if a Session Start event had just occurred. - - This is useful for integrations that want to delay presentation - of startup campaigns due to some startup state, such as a splash screen. - In order to delay the triggering, implement - LLMessagingListener and respond appropriately to - [LLMessagingListener localyticsShouldDelaySessionStartInAppMessages]. - Finally, once the start up state has cleared, call this method to trigger In-App - campaigns as if a session had just been started. - - @Version SDK4.3.0 - */ -+ (void)triggerInAppMessagesForSessionStart NS_AVAILABLE_IOS(9_0); - -/** - * If an In-App message is currently displayed, dismiss it. Is a no-op otherwise. - - * @Version SDK3.0 - */ -+ (void)dismissCurrentInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an In-App impression - * - * @param campaign The In-App campaign for which to tag an impression - * @param impressionType an enum of LLImpressionTypeClick or LLImpressionTypeDismiss - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInAppCampaign:(nonnull LLInAppCampaign *)campaign - withType:(LLImpressionType)impressionType NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an In-App impression. - * This method should be used when the standard methods are not intended. If a standard - * impression is desirable use [Localytics tagInAppImpression:withImpressionType:} - * - * Any NSString value passed in that is not equal to 'X' will result in a click on the dashboard. - * If an empty NSString is passed in, a dismiss impression will be tagged. - * - * @param campaign The In-App campaign for which to tag an impression - * @param customAction an NSString to tag the impression with. - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInAppCampaign:(nonnull LLInAppCampaign *)campaign - withCustomAction:(nonnull NSString *)customAction NS_AVAILABLE_IOS(9_0); - - -/** -Trigger an In-App message, forcing it to display immediately. - -This method is useful for certain use cases such as onboarding, where a message should -be shown to a user immediately, and all rules, such as frequency capping, audience -segmentation, and triggering logic can be ignored. - - No In-App will be shown if: - -* An In-App is already displaying - -* The specified campaign ID and/or creative ID don't match a valid campaign - -* The specified campaign ID and/or creative ID don't apply to this application key - -@param campaignId The In-App campaign ID, as defined in the Localytics Dashboard, for which to force an In-App -@param creativeId The In-App creative ID, as defined in the Localytics Dashboard, for which to force an In-App - -@Version SDK6.2.0 -*/ -+ (void)forceInAppMessageDisplay:(nonnull NSString *)campaignId forCreative:(nonnull NSString *)creativeId; - -/** -Trigger an In-App message, forcing it to display immediately. - -This method is useful for certain use cases such as onboarding, where a message should -be shown to a user immediately, and all rules, such as frequency capping, audience -segmentation, and triggering logic can be ignored. - - No In-App will be shown if: - -* An In-App is already displaying - -* The specified url is not a local file - -* The specified url points to an empty file - -@param localFileUrl The absolute file path to a local file - -@Version SDK6.2.0 -*/ -+ (void)forceInAppMessageDisplay:(nonnull NSURL *)localFileUrl; - -#pragma mark - Inbox - -/** Returns an array of all Inbox campaigns that are enabled and can be displayed. - @return an array of LLInboxCampaign objects - - @Version SDK5.2.0 - */ -+ (nonnull NSArray *)displayableInboxCampaigns NS_AVAILABLE_IOS(9_0); - -/** Returns an array of all Inbox campaigns that are enabled. The return value will include Inbox - campaigns with no listing title, and thus no visible UI element as well as deleted Inbox campaigns. - @return an array of LLInboxCampaign objects - - @Version SDK4.4.0 - */ -+ (nonnull NSArray *)allInboxCampaigns NS_AVAILABLE_IOS(9_0); - -/** Refresh inbox campaigns from the Localytics server that are enabled and can be displayed. - @param completionBlock the block invoked with refresh is complete - - @Version SDK3.7.0 - */ -+ (void)refreshInboxCampaigns:(nonnull void (^)(NSArray * _Nullable inboxCampaigns))completionBlock NS_AVAILABLE_IOS(9_0); - -/** Refresh inbox campaigns from the Localytics server that are enabled. The return value will - include Inbox campaigns with no listing title, and thus no visible UI element as well as deleted Inbox campaigns. - @param completionBlock the block invoked with refresh is complete - - @Version SDK4.4.0 - */ -+ (void)refreshAllInboxCampaigns:(nonnull void (^)(NSArray * _Nullable inboxCampaigns))completionBlock NS_AVAILABLE_IOS(9_0); - -/** Set an Inbox campaign as read. Read state can be used to display opened but not disabled Inbox - campaigns differently (e.g. greyed out). - @param campaign an LLInboxCampaign that should have its read flag changed. - @param read YES to mark the campaign as read, NO to mark it as unread - @see LLInboxCampaign - - @Version SDK4.4.0 - */ -+ (void)setInboxCampaign:(nonnull LLInboxCampaign *)campaign asRead:(BOOL)read NS_AVAILABLE_IOS(9_0); - -/** Set an Inbox campaign as deleted. Deleted Inbox campaigns will not be returned from - the list of visible inbox campaigns. - @param campaign an LLInboxCampaign that should be deleted - @see LLInboxCampaign - - @Version SDK5.2.0 - */ -+ (void)deleteInboxCampaign:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** Get the count of unread inbox messages - @return the count of unread inbox messages - - @Version SDK4.0 - */ -+ (NSInteger)inboxCampaignsUnreadCount NS_AVAILABLE_IOS(9_0); - -/** Returns a inbox campaign detail view controller with the given inbox campaign data. - * @param campaign The INbox campaign for which to retrieve an Inbox detail ViewController. - * @return a LLInboxDetailViewController from a given LLInboxCampaign object - * - @Version SDK3.7.0 - */ -+ (nonnull LLInboxDetailViewController *)inboxDetailViewControllerForCampaign:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an Inbox impression - * - * @param campaign The Inbox campaign for which to tag an impression - * @param impressionType an enum of LLImpressionTypeClick or LLImpressionTypeDismiss - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInboxCampaign:(nonnull LLInboxCampaign *)campaign - withType:(LLImpressionType)impressionType NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an Inbox impression. - * This method should be used when the standard methods are not intended. If a standard - * impression is desirable use [Localytics tagInboxImpression:withImpressionType:} - * - * Any NSString value passed in that is not equal to 'X' will result in a click on the dashboard. - * If an empty NSString is passed in, a dismiss impression will be tagged. - * - * @param campaign The Inbox campaign for which to tag an impression - * @param customAction an NSString to tag the impression with. - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInboxCampaign:(nonnull LLInboxCampaign *)campaign - withCustomAction:(nonnull NSString *)customAction NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Push to Inbox impression. - * - * @param campaign The Inbox campaign for which to tag an impression - * @param success Whether or not the deep link was successful - * - * @Version SDK4.4.0 - */ -+ (void)tagImpressionForPushToInboxCampaign:(nonnull LLInboxCampaign *)campaign - success:(BOOL)success NS_AVAILABLE_IOS(9_0); - -/** - * Tell the Localytics SDK that an Inbox campaign was tapped in the list view. - * - * @param campaign The Inbox campaign that was tapped in the list view. - * - * @Version SDK4.4.0 - */ -+ (void)inboxListItemTapped:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * FOR LOCALYTICS WRAPPER USE ONLY - * - * @param webViewConfig The WebViewConfiguration responsible for handling webview events - * @param campaign The Inbox campaign that will be displayed - * - * @Version SDK5.4.1 - */ -+ (void)setupWebViewConfiguration:(nonnull WKWebViewConfiguration *)webViewConfig withCampaign:(nullable LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * FOR LOCALYTICS WRAPPER USE ONLY - * - * @Version SDK5.4.1 - */ -+ (nullable LLMarketingWebViewHandler *)marketingWebViewHandler NS_AVAILABLE_IOS(9_0); - -#pragma mark - Location - -/** Enable or disable location monitoring for geofence monitoring. When enabled, - invokes requestAlwaysAuthorization callback of the LLCallToActionDelegate. - The Delgate should be implemented to prompt for location permissions. - @param enabled YES to enable location monitoring, NO to disable monitoring - - @Attention - SDK5.3 requires LLCallToActionDelegate callback requestAlwaysAuthorization to be implemented - @Version SDK4.3 - */ -+ (void)setLocationMonitoringEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** Enable or disable location monitoring for geofence monitoring. Using this method will - tell Localytics to always look for location permission status, and whenever granted by the end user, - track their location for geofencing purposes. This method will NOT request location permissions. - @param persist YES to allow Localytics to enable location monitoring whenever available, NO to prevent that behavior - - * @Version SDK5.3 - */ -+ (void)persistLocationMonitoring:(BOOL)persist NS_AVAILABLE_IOS(9_0); - -/** Retrieve the closest 20 geofences to monitor based on the devices current location. This method - should be used if you would rather manage location updates and region monitoring instead of - allowing the Localytics SDK to manage location updates and region monitoring automatically when - using persistLocationMonitoring:withForegroundOnlyCapabilities:. This method should be used in conjunction with triggerRegion:withEvent: - and triggerRegions:withEvent:atLocation: to notify the Localytics SDK that regions have been entered or exited. - @param currentCoordinate The devices current location coordinate - @see triggerRegion:withEvent:atLocation: - @see triggerRegions:withEvent:atLocation: - - * @Version SDK4.0 - */ -+ (nonnull NSArray *)geofencesToMonitor:(CLLocationCoordinate2D)currentCoordinate NS_AVAILABLE_IOS(9_0); - -/** Trigger a region with a certain event. This method should be used in conjunction with geofencesToMonitor:. - @param region The CLRegion that is triggered - @param event The triggering event (enter or exit) - @param location A CLLocation that will update the closest geofences for future triggers - @see geofencesToMonitor: - - * @Version SDK5.0 - */ -+ (void)triggerRegion:(nonnull CLRegion *)region withEvent:(LLRegionEvent)event atLocation:(nullable CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** Trigger regions with a certain event at a certain location. This method should be used in - conjunction with geofencesToMonitor:. - @param regions An array of CLRegion object that are triggered - @param event The triggering event (enter or exit) - @param location A CLLocation that will update the closest geofences for future triggers - @see geofencesToMonitor: - * - * @Version SDK5.0 - */ -+ (void)triggerRegions:(nonnull NSArray *)regions withEvent:(LLRegionEvent)event atLocation:(nullable CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Places Push Received. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * - * @Version SDK4.3.0 - */ -+ (void)tagPlacesPushReceived:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Places Push Opened. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * - * @Version SDK4.3.0 - */ -+ (void)tagPlacesPushOpened:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * An event to tag a Places Push Opened with a custom action. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * @param identifier The specific notification action associated with the opened push notification. - * - * @Version SDK4.4.0 - */ -+ (void)tagPlacesPushOpened:(nonnull LLPlacesCampaign *)campaign - withActionIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** - * Trigger a places notification for the given campaign - * - * @param campaign The Places campaign for which to trigger a notification - * - * @Version SDK4.3.0 - */ - -+ (void)triggerPlacesNotificationForCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Trigger a places notification for the given campaign id and regionId - * - * @param campaignId The Places campaign id for which to trigger a notification - * @param regionId The Places region id for which to trigger a notification - * - * @Version SDK4.3.0 - */ - -+ (void)triggerPlacesNotificationForCampaignId:(NSInteger)campaignId - regionIdentifier:(nonnull NSString *)regionId NS_AVAILABLE_IOS(9_0); - - -#pragma mark - In-App Message Delegate -/** --------------------------------------------------------------------------------------- - * @name In-App Message Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set a Messaging delegate - @param delegate An object that implements the LLMessagingDelegate. - @see LLMessagingDelegate - - @Version SDK4.0 - */ -+ (void)setMessagingDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Set a CallToAction delegate - @param delegate An object that implements the LLCallToActionDelegate. - @see LLCallToActionDelegate - - @Version SDK4.0 - */ -+ (void)setCallToActionDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Set whether ADID parameter is added to In-App call to action URLs. By default - the ADID parameter will be added to call to action URLs. - @param enabled Set to YES to enable the ADID parameter or NO to disable it - - * @Version SDK3.4 - */ -+ (void)setInAppAdIdParameterEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** Set whether ADID parameter is added to Inbox call to action URLs. By default - the ADID parameter will be added to call to action URLs. - @param enabled Set to YES to enable the ADID parameter or NO to disable it - - * @Version SDK5.0 - */ -+ (void)setInboxAdIdParameterEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Location Delegate -/** --------------------------------------------------------------------------------------- - * @name Location Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set a Location delegate - @param delegate An object implementing the LLLocationDelegate protocol. - @see LLLocationDelegate - - * @Version SDK4.0 - */ -+ (void)setLocationDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -#endif - -@end - -/** - @discussion The class which manages creating, collecting, & uploading a Localytics session. - Please see the following guides for information on how to best use this - library, sample code, and other useful information: - - - Best Practices -
    -
  • Integrate Localytics in applicationDidFinishLaunching.
    • -
  • Open your session and begin your uploads in applicationDidBecomeActive. This way the - upload has time to complete and it all happens before your users have a - chance to begin any data intensive actions of their own.
    • -
  • Close the session in applicationWillResignActive.
    • -
  • Do not call any Localytics functions inside a loop. Instead, calls - such as tagEvent should follow user actions. This limits the - amount of data which is stored and uploaded.
    • -
  • Do not instantiate a Localtyics object, instead use only the exposed class methods.
    • -
- - * @Version SDK3.0 - */ -@interface Localytics : NSObject -@end - -#pragma mark - - -/** - * A protocol used to receive analytics callbacks. - - * @Version SDK3.0 - */ -@protocol LLAnalyticsDelegate -@optional - -/** - * Callback that a session will be opened. Only called when resuming or opening a new session. - * Is not called if a session is currently open. - * - * @param isFirst Boolean indicating that the session will be the first session ever opened - * for this installation. - * @param isUpgrade Boolean indicating that the session will be the first session opened since - * the app was upgraded. - * @param isResume Boolean indicating that an old session will be resumed, as opposed to - * a new session being opened. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionWillOpen:(BOOL)isFirst isUpgrade:(BOOL)isUpgrade isResume:(BOOL)isResume NS_AVAILABLE_IOS(9_0); - -/** - * Callback that a session was either opened or resumed. Is not called if a session was already open. - * - * @param isFirst Boolean indicating that the session is the first session ever opened - * for this installation. - * @param isUpgrade Boolean indicating that the session is the first session opened since - * the app was upgraded. - * @param isResume Boolean indicating that an old session was resumed, as opposed to - * a new session was opened. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionDidOpen:(BOOL)isFirst isUpgrade:(BOOL)isUpgrade isResume:(BOOL)isResume NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an event was tagged. - * - * @param eventName The name of the event. - * @param attributes The event's attributes. - * @param customerValueIncrease The change in a customer's lifetime value associated with this event. - * - * @Version SDK3.0 - */ -- (void)localyticsDidTagEvent:(nonnull NSString *)eventName - attributes:(nullable NSDictionary *)attributes - customerValueIncrease:(nullable NSNumber *)customerValueIncrease NS_AVAILABLE_IOS(9_0); - -/** - * Callback that a session will be closed. Is called only if a session is currently open. Note that - * the session might be resumed if [Localytics openSession] is called, so there is no guarantee that - * the session will actually close after this callback. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionWillClose; - -@end - - -#if !TARGET_OS_TV - -/** - * A protocol used to receive messaging callbacks. - - * @Version SDK3.0.0 - */ -@protocol LLMessagingDelegate -@optional - -/** - * Callback to determine if an In-App campaign should be shown. - * - * @param campaign The campaign that will be shown - * @return The decision to show the In-App campaign. - * - * @Version SDK4.3.0 - */ -- (BOOL)localyticsShouldShowInAppMessage:(nonnull LLInAppCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * 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. - * - * @see [Localytics triggerInAppMessagesForSessionStart] - * - * @return The decision to delay In-App campaigns triggered by the "Session Start" event. - * - * @Version SDK4.3.0 - */ -- (BOOL)localyticsShouldDelaySessionStartInAppMessages NS_AVAILABLE_IOS(9_0); - -/** - * Callback to modify presentation of an In-App Campaign. - * - * @param campaign An immutable object representing the campaign that will be shown - * @param configuration An object representing the mutable visual state of the In-App campaign - * @see LLInAppConfiguration - * @return The modified configuration object containing all preferred display values. - * - * @Version SDK3.0 - */ -- (nonnull LLInAppConfiguration *)localyticsWillDisplayInAppMessage:(nonnull LLInAppCampaign *)campaign withConfiguration:(nonnull LLInAppConfiguration *)configuration NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message was displayed. - * - * @Version SDK3.0 - */ -- (void)localyticsDidDisplayInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message will be dismissed. - * - * @Version SDK3.0 - */ -- (void)localyticsWillDismissInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message was dismissed. - * - * @Version SDK3.0 - */ -- (void)localyticsDidDismissInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller will be shown. This method is called from the viewWillAppear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsWillDisplayInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller was just shown. This method is called from the viewDidAppear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsDidDisplayInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller will be dismissed. This method is called from the viewWillDisappear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsWillDismissInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller was just dismissed. This method is called from the viewDidDisappear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsDidDismissInboxDetailViewController NS_AVAILABLE_IOS(9_0); - - -/** - * Callback to determine if the triggering of a Places campaign should show a local notification. - * - * @param campaign An object defining a Places Campaign - * @return The decision to show the local notification. - * - * @Version SDK4.0 - */ -- (BOOL)localyticsShouldDisplayPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Callback to modify the appearance of a local notification. - * - * @param notification The iOS local notification. - * @param campaign The campaign that triggered the Places notification - * @return The iOS notification with all updated preferences - * - * @Version SDK4.0 - */ -- (nonnull UILocalNotification *)localyticsWillDisplayNotification:(nonnull UILocalNotification *)notification forPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_DEPRECATED_IOS(9_0, 10_0); - -/** - * Callback to modify the appearance of a local notification. - * - * @param notification The iOS notification content used to customize a local notification. - * @param campaign The campaign that triggered the Places notification - * @return The iOS notification content with all updated preferences - * - * @Version SDK4.1.0 - */ -- (nonnull UNMutableNotificationContent *)localyticsWillDisplayNotificationContent:(nonnull UNMutableNotificationContent *)notification forPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(10_0); - -@end - - -/** - * A protocol used to receive location updates. - * - * @Version SDK4.0 - */ -@protocol LLLocationDelegate -@optional - -/** - * Callback for when a significant location update occurs. - * - * @param location An object representing the updated location. - * - * @Version SDK4.0 - */ -- (void)localyticsDidUpdateLocation:(nonnull CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** - * Callback for when Localytics updates the regions that are being monitored. - * - * @param addedRegions The list of regions that will be added to monitoring - * @param removedRegions The list of regions which will no longer be monitored. - * - * @Version SDK4.0 - */ -- (void)localyticsDidUpdateMonitoredRegions:(nonnull NSArray *)addedRegions removeRegions:(nonnull NSArray *)removedRegions NS_AVAILABLE_IOS(9_0); - -/** - * Callback for when Localytics recognized the entering or exiting of certain regions - * - * @param regions The list of regions that have been triggered - * @param event An event indicating if the regions were triggered due to entering or exiting. - * - * @Version SDK4.0 - */ -- (void)localyticsDidTriggerRegions:(nonnull NSArray *)regions withEvent:(LLRegionEvent)event NS_AVAILABLE_IOS(9_0); - -@end - -/** - * A protocol used to receive information about Call To Actions triggered by Localytics campaigns. - * - * @Version SDK5.0 - */ -@protocol LLCallToActionDelegate -@optional - -/** - * @param url The URL that was triggered inside a Localytics call to action from any - * messaging (Push, Places, In-App or Inbox) campaign - * @param campaign The campaign that triggered this deeplink (in the case of push, this will be nil). - * @return The decision to allow Localytics to handle the deeplink - */ -- (BOOL)localyticsShouldDeeplink:(nonnull NSURL *)url campaign:(nullable LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * 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. - * - * @param optedOut The result of the call to action indicating that the user opted in (false) or out (true). - * @param campaign The campaign which triggered the opt in/out call. - */ -- (void)localyticsDidOptOut:(BOOL)optedOut campaign:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * 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. - * - * @param privacyOptedOut The result of the call to action indicating that the user opted in (false) or out (true). - * @param campaign The campaign which triggered the privacy opt in/out call. - */ -- (void)localyticsDidPrivacyOptOut:(BOOL)privacyOptedOut campaign:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a location when in use permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the location when in use permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForLocationWhenInUsePermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a location always permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the location always permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForLocationAlwaysPermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a notification permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the notification permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForNotificationPermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Callback to indicate that a user has triggered a deeplink to the settings using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - @param campaign The campaign which triggered the notification permission prompt. - @return boolean indicating if Localytics should proceed. Returning false will prevent the deeplink to settings. - * - * @Version SDK 5.3 - */ -- (BOOL)localyticsShouldDeeplinkToSettings:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); - - -/** - * Callback to request the Always Authorization. Localytics setLocationMonitoringEnabled API requires implementation of this callback. - * @param locationManager CLLocationManager instance to request Authorization - * @discussion Sample Implementation\: [locationManager requestAlwaysAuthorization]; - - @Note Apple requires application developers to be aware and request permissions needed by SDK. - @Version SDK 5.3 - */ -- (void)requestAlwaysAuthorization:(nonnull CLLocationManager *)locationManager NS_AVAILABLE_IOS(9_0); - -/** - * Callback to request When in Use Authorization. - @param locationManager CLLocationManager instance to request Authorization - * - * Sample Implementation \: [locationManager requestWhenInUseAuthorization]; - @Note Apple requires application developers to be aware and request permissions needed by SDK. - @Version SDK 5.3 - */ -- (void)requestWhenInUseAuthorization:(nonnull CLLocationManager *)locationManager NS_AVAILABLE_IOS(9_0); -@end -#endif - diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LocalyticsTypes.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LocalyticsTypes.h deleted file mode 100644 index 6c4255c..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Headers/LocalyticsTypes.h +++ /dev/null @@ -1,93 +0,0 @@ -// -// LocalyticsTypes.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - - -/** An enum to define the location that the In-App dismiss button should be shown. */ -typedef NS_ENUM(NSUInteger, LLInAppMessageDismissButtonLocation){ - /** A value to specify rendering of the In-App dismiss button on the left. */ - LLInAppMessageDismissButtonLocationLeft, - /** A value to specify rendering of the In-App dismiss button on the right. */ - LLInAppMessageDismissButtonLocationRight -}; - -/** An enum to define the event type that triggered a geofence. */ -typedef NS_ENUM(NSInteger, LLRegionEvent){ - /** A value to specify that the geofence boundary was crossed as an entrance into the geofence */ - LLRegionEventEnter, - /** A value to specify that the geofence boundary was crossed as an exit out the geofence */ - LLRegionEventExit -}; - -/** An enum to define the scope a profile attribute should be associated with. */ -typedef NS_ENUM(NSInteger, LLProfileScope){ - /** A value to specify that the profile attribute is scoped to this specific application and doesn't apply in other applications */ - LLProfileScopeApplication, - /** A value to specify that the profile attribute is scoped to the organization and applies across all apps */ - LLProfileScopeOrganization -}; - -/** An enum to define the type of In-App. */ -typedef NS_ENUM(NSInteger, LLInAppMessageType) { - /** A value to specify that the In-App is a top banner campaign. */ - LLInAppMessageTypeTop, - /** A value to specify that the In-App is a bottom banner campaign. */ - LLInAppMessageTypeBottom, - /** A value to specify that the In-App is a center campaign. */ - LLInAppMessageTypeCenter, - /** A value to specify that the In-App is a full screen campaign. */ - LLInAppMessageTypeFull -}; - -/** An enum to specify the default conversion type of an In-App. */ -typedef NS_ENUM(NSInteger, LLImpressionType) { - /** A value to specify the default value of click, which will be counted as a conversion */ - LLImpressionTypeClick, - /** A value to specify the default value of dismiss, which will not be counted as a conversion */ - LLImpressionTypeDismiss -}; - -// For iOS 13.x and below compatibility, numbers match to ATTrackingManagerAuthorizationStatus enum -typedef NS_ENUM(NSInteger, LLAdIdStatus) { - LL_IDFA_NOT_DETERMINED = 0, - LL_IDFA_RESTRICTED = 1, - LL_IDFA_DENIED = 2, - LL_IDFA_AUTHORIZED = 3, - LL_IDFA_NOT_REQUIRED = 4 -}; - -/** - Represents the interval at which the Localytics SDK will upload data in the case of a WiFi - connection. Having a WiFi connection will supersede any mobile data connection. Default value - is 5 seconds. To disable uploading for this connectivity set the value to -1 - */ -#define LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS @"ll_wifi_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 4G - or LTE connections. Default value is 10 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_great_network_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 3G - connection. Default value is 30 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_decent_network_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 2G - or EDGE connections. Default value is 90 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_bad_network_upload_interval_seconds" - diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Info.plist b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Info.plist deleted file mode 100644 index f6d1f64..0000000 Binary files a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Info.plist and /dev/null differ diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Localytics b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Localytics deleted file mode 100755 index 280dcd1..0000000 Binary files a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Localytics and /dev/null differ diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Modules/module.modulemap b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Modules/module.modulemap deleted file mode 100644 index c8f9fed..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module Localytics { - umbrella header "Localytics-Framework.h" - - export * - module * { export * } -} diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h deleted file mode 100644 index dfa6e1a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_armv7/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h +++ /dev/null @@ -1,24 +0,0 @@ -#import - -@class LLApsDictionary; -@class LLMarketingLogger; -@protocol LLLocalyticsDelegate; - -@interface LLPushToInboxCampaignJson : NSObject - -@property (nonatomic, copy, readonly, nonnull) NSDictionary *attributes; -@property (nonatomic, copy, readonly, nonnull) NSDictionary *markerDictionary; - -- (nonnull NSDictionary *)generateLoggingDictionary; - -+ (nullable instancetype)withPayload:(nonnull NSDictionary *)payload - apsDictionary:(nonnull LLApsDictionary *)apsDictionary - logger:(nonnull LLMarketingLogger *)logger - localyticsDelegate:(nonnull id)localyticsDelegate; - -- (nullable instancetype)initWithPayload:(nonnull NSDictionary *)payload - apsDictionary:(nonnull LLApsDictionary *)apsDictionary - logger:(nonnull LLMarketingLogger *)logger - localyticsDelegate:(nonnull id)localyticsDelegate; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCampaignBase.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCampaignBase.h deleted file mode 100644 index ca97b5d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCampaignBase.h +++ /dev/null @@ -1,47 +0,0 @@ -// -// LLCampaignBase.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** An enum to define the specific channel that this campaign belongs to */ -typedef NS_ENUM(NSInteger, CampaignType) { - /** A value to specify that this campaign is an In-App campaign */ - CampaignTypeInApp, - /** A value to specify that this campaign is a Push campaign */ - CampaignTypePush, - /** A value to specify that this campaign is an Inbox campaign */ - CampaignTypeInbox, - /** A value to specify that this campaign is a Places campaign */ - CampaignTypePlaces -}; - -/** - * A base campaign class containing information relevant to all campaign types - */ -@interface LLCampaignBase : NSObject -// Make sure to override all properties in copyWithZone! - -/** - * The unique campaign id. - */ -@property (nonatomic, assign, readonly) NSInteger campaignId; - -/** - * The campaign name - */ -@property (nonatomic, copy, readonly, nonnull) NSString *name; - -/** - * The attributes associated with the campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *attributes; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCustomer.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCustomer.h deleted file mode 100644 index 801c62a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLCustomer.h +++ /dev/null @@ -1,92 +0,0 @@ -// -// LLCustomer.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A customer object builder used to set a customer's: - * - id - * - first name - * - last name - * - full name - * - email address - */ -@interface LLCustomerBuilder : NSObject - -/** - * Builder setter for customer's id - */ -@property (nonatomic, strong, nullable) NSString* customerId; - -/** - * Builder setter for customer's first name - */ - -@property (nonatomic, strong, nullable) NSString* firstName; -/** - * Builder setter for customer's last name - */ - -@property (nonatomic, strong, nullable) NSString* lastName; -/** - * Builder setter for customer's full name - */ -@property (nonatomic, strong, nullable) NSString* fullName; - -/** - * Builder setter for customer's email address - */ -@property (nonatomic, strong, nullable) NSString* emailAddress; - -@end - - -/** - * A customer object. A customer can have: - * - id - * - first name - * - last name - * - full name - * - email address - */ -@interface LLCustomer : NSObject - -/** - * Customer's id - */ -@property (nonatomic, strong, readonly, nullable) NSString* customerId; - -/** - * Customer's first name - */ -@property (nonatomic, strong, readonly, nullable) NSString* firstName; - -/** - * Customer's last name - */ -@property (nonatomic, strong, readonly, nullable) NSString* lastName; - -/** - * Customer's full name - */ -@property (nonatomic, strong, readonly, nullable) NSString* fullName; - -/** - * Customer's email address - */ -@property (nonatomic, strong, readonly, nullable) NSString* emailAddress; - -/** - * Constructor for a customer object using a customer builder - */ -+ (nullable instancetype)customerWithBlock:(nonnull void (^)(LLCustomerBuilder * __nonnull builder))block; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLGeofence.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLGeofence.h deleted file mode 100644 index 7f11768..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLGeofence.h +++ /dev/null @@ -1,24 +0,0 @@ -// -// LLGeofence.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A class representing a circular region - */ -@interface LLGeofence : LLRegion - -/** - * The Core Location circular region object associated with this region - */ -@property (nonatomic, copy, readonly, nonnull) CLCircularRegion *region; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppCampaign.h deleted file mode 100644 index 3f18ab7..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppCampaign.h +++ /dev/null @@ -1,70 +0,0 @@ -// -// LLInAppCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import -#import - -/** - * The campaign class containing information relevant to a single In-App campaign. - * - * @see LLWebViewCampaign - * @see LLCampaignBase - */ -@interface LLInAppCampaign : LLWebViewCampaign -// Make sure to override all properties in copyWithZone! - -/** - * The type of In-App message associated with this campaign. - */ -@property (nonatomic, assign, readonly) LLInAppMessageType type; - -/** - * Value indicating if the campaign has a responsive creative for various sizes. - */ -@property (nonatomic, assign, readonly) BOOL isResponsive; - -/** - * Value indicating the desired aspect ratio for presentation (only relevant for center campaigns). - */ -@property (nonatomic, assign, readonly) CGFloat aspectRatio; - -/** - * Value indicating the desired offset for presentation (only relevant for banner campaigns) - */ -@property (nonatomic, assign, readonly) CGFloat offset; - -/** - * Value indicating the desired background alpha for presentation (only relevant for center and fullscreen campaigns) - */ -@property (nonatomic, assign, readonly) CGFloat backgroundAlpha; - -/** - * Value indicating if the dismiss button is hidden - */ -@property (nonatomic, assign, getter=isDismissButtonHidden, readonly) BOOL dismissButtonHidden; - -/** - * Value indicating the location of the dismiss button (left or right) - */ -@property (nonatomic, assign, readonly) LLInAppMessageDismissButtonLocation dismissButtonLocation; - -/** - * Value indicating the name of the event that triggered the In-App campaign. - */ -@property (nonatomic, copy, readonly, nonnull) NSString *eventName; - -/** - * Value indicating the attributes on the event that triggered the In-App campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *eventAttributes; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppConfiguration.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppConfiguration.h deleted file mode 100644 index debf09a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInAppConfiguration.h +++ /dev/null @@ -1,89 +0,0 @@ -// -// LLInAppConfiguration.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@class UIImage; - -/** - * The In-App's configuration object used to define certain properties that can be modified on an In-App message. - */ -@interface LLInAppConfiguration : NSObject - -/** The location of the dismiss button on an In-App message */ -@property (nonatomic, assign) LLInAppMessageDismissButtonLocation dismissButtonLocation; -/** The image of the dismiss button on an In-App message */ -@property (nonatomic, strong, nullable) UIImage *dismissButtonImage; -/** The hidden state of the dismiss button on an In-App message */ -@property (nonatomic, assign) BOOL dismissButtonHidden; -/** - Set the aspect ratio for this In-App. The aspect ratio should be a float value representing a ratio of height to width (example 9:16 display is 0.56). - Accepted values must be greater than 0. This property is only relevant for Center and Banner In-App messages. - */ -@property (nonatomic, assign) CGFloat aspectRatio; - -/** - Set the aspect ratio for this In-App. The aspect ratio should be a float value representing a ratio of width to height (example 16:9 display is 1.77). - Accepted values must be greater than 0. This property is only relevant for Center and Banner In-App messages. - */ -@property (nonatomic, assign) CGFloat widthToHeightRatio; -/** The offset of the In-App msg. This property is only relevant for top or bottom banner In-App messages */ -@property (nonatomic, assign) CGFloat offset; -/** - * Set the background alpha for this in-app. The background alpha should be a float value - * representing the desired transparency for the backdrop of the creative. - * - * Accepted values must be greater than 0 and less than 1. - * - * This property is only relevant for center and full - * screen in-app Campaigns - * - * @param backgroundAlpha a float value greater than 0 and less than 1 - * representing the transparency of the campaign backdrop. - */ -@property (nonatomic, assign) CGFloat backgroundAlpha; -/** AutoHide Home Screen Indicator */ -@property (nonatomic, assign) BOOL autoHideHomeScreenIndicator; -/** The screen area covered by the In-app. - * NO - Within Safe Area - * YES - Covers Entire Screen and html needs to handle notch and screen curvature. - */ -@property (nonatomic, assign) BOOL notchFullScreen; - -/** The percentage of the in-app video that needs to be watched before sending a video event */ -@property(nonatomic, assign) CGFloat videoConversionPercentage; - -/** Returns whether this is a center In-App message. - @return YES if this is a center In-App message, NO otherwise - */ -- (BOOL)isCenterCampaign; -/** Returns whether this is a top banner In-App message. - @return YES if this is a top banner In-App message, NO otherwise - */ -- (BOOL)isTopBannerCampaign; -/** Returns whether this is a bottom banner In-App message. - @return YES if this is a bottom banner In-App message, NO otherwise - */ -- (BOOL)isBottomBannerCampaign; -/** Returns whether this is a full screen In-App message. - @return YES if this is a full screen In-App message, NO otherwise - */ -- (BOOL)isFullScreenCampaign; - -/** Set the image to be used for dimissing an In-App message by providing the name of the - image to be loaded and used - @param imageName The name of an image to be loaded and used for dismissing an In-App - message. By default the image is a circle with an 'X' in the middle of it - */ -- (void)setDismissButtonImageWithName:(nonnull NSString *)imageName; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxCampaign.h deleted file mode 100644 index 486b570..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxCampaign.h +++ /dev/null @@ -1,81 +0,0 @@ -// -// LLInboxCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -/** - * The campaign class containing information relevant to a single inbox campaign. - * - * @see LLWebViewCampaign - * @see LLCampaignBase - */ -@interface LLInboxCampaign : LLWebViewCampaign -// Make sure to override all properties in copyWithZone! - -/** - * The flag indicating whether the campaign has been read. - * - * Note: Changing this value will automatically update the inbox campaign record - * in the Localytics database. - */ -@property (nonatomic, assign, getter=isRead) BOOL read; - -/** - * The preview title text. - */ -@property (nonatomic, copy, readonly, nullable) NSString *titleText; - -/** - * The preview description text. - */ -@property (nonatomic, copy, readonly, nullable) NSString *summaryText; - -/** - * The remote url of the thumbnail. - */ -@property (nonatomic, copy, readonly, nullable) NSURL *thumbnailUrl; - -/** - * Value indicating if the campaign has a creative. - */ -@property (nonatomic, assign, readonly) BOOL hasCreative; - -/** - * The sort order of the campaign. - */ -@property (nonatomic, assign, readonly) NSInteger sortOrder; - -/** - * The received date of the campaign. - */ -@property (nonatomic, assign, readonly) NSTimeInterval receivedDate; - -/** - * The deep link of the campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSURL *deepLinkURL; - -/** - * True if this inbox campaign was created from a push campaign. - */ -@property (nonatomic, assign, readonly) BOOL isPushToInboxCampaign; - -@property (nonatomic, assign, readwrite) CGFloat videoConversionPercentage; - -/** - * True if this inbox campaign has been deleted. - */ -@property (nonatomic, assign, getter=isDeleted, readonly) BOOL deleted; - -- (void)delete; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxDetailViewController.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxDetailViewController.h deleted file mode 100644 index e2f7825..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxDetailViewController.h +++ /dev/null @@ -1,53 +0,0 @@ -// -// LLInboxDetailViewController.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -@class LLInboxCampaign; - -/** - * UIViewController class that displays an inbox campaign's full creative. This class also handles tagging - * impression events when a call to action is tapped within the creative or when the UIViewController is - * dismissed. - * - * Customization options: - * - Error view, @see errorView - * - * @see LLInboxViewController - */ -@interface LLInboxDetailViewController : UIViewController - -/** - * The inbox campaign being displayed - */ -@property (nonatomic, strong, readonly, nonnull) LLInboxCampaign *campaign; - -/** - * The UIView to show when the full creative fails to load. If this property is not set, a gray 'X' will - * be shown in the center of the view. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxDetailViewController. - */ -@property (nonatomic, strong, nullable) UIView *creativeLoadErrorView; - -/** - * Flag indicating whether delete should be implemented as a navigation item on the detail view controller. - */ -@property (nonatomic, assign) BOOL deleteInNavBar; - -/** - * The string to use to indicate the "Delete" action to the user. The default value is "Delete" - */ -@property (nonatomic, strong, nullable) NSString *deleteActionText; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxViewController.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxViewController.h deleted file mode 100644 index cd0372c..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLInboxViewController.h +++ /dev/null @@ -1,150 +0,0 @@ -// -// LLInboxViewController.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@protocol LLInboxCampaignsRefreshingDelegate -@optional - -- (void)localyticsDidBeginRefreshingInboxCampaigns; -- (void)localyticsDidFinishRefreshingInboxCampaigns; - -@end - -/** - * UIViewController class that loads inbox campaigns and displays them in a UITableView. - * This class also handles marking inbox campaigns as read and displaying the inbox - * campaign's full creative when it is tapped by pushing an LLInboxDetailViewController - * onto the UINavigationController stack. - * - * By default this class uses custom UITableViewCells which include an unread indicator, title text, - * summary text (when available), thumbnail image (when available), and created time text. - * - * Customization options: - * - Empty campaigns view, @see property emptyCampaignsView - * - Show UIActivityIndicatorView while loading campaigns, @see property showsActivityIndicatorView - * - UITableViewCells, override tableView:cellForRowAtIndexPath: - * - Full creative display, override tableView:didSelectRowAtIndexPath:, Note: You must also handle - * setting the LLInboxCampaign to be read and checking the existense of the creativeUrl property of - * the LLInboxCampaign object. - * - Implement delete using a swipe action @see property enableSwipeDelete or in the navigation bar from - * the detail view @see property enableDetailViewDelete - * - * @see LLInboxDetailViewController - */ -@interface LLInboxViewController : UIViewController - -/** - * The UITableView that shows the inbox campaigns. - */ -@property (nonatomic, strong, nonnull) UITableView *tableView; - -/** - * The NSArray of LLInboxCampaigns backing the UITableView - */ -@property (nonatomic, strong, nullable) NSArray *tableData; - -/** - * The UIView to show when there are no inbox campaigns to display. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxViewController. - */ -@property (nonatomic, strong, nonnull) UIView *emptyCampaignsView; - -/** - * Flag indicating whether a UIActivityIndicatorView should be shown will campaigns are loading. - */ -@property (nonatomic, assign) BOOL showsActivityIndicatorView; - -/** - * Flag indicating whether delete should be implemented as a swipe action on the list view - */ -@property (nonatomic, assign) BOOL enableSwipeDelete; - -/** - * The string to use to indicate the "Delete" action to the user. The default value is "Delete" - */ -@property (nonatomic, strong, nullable) NSString *deleteActionText; - -/** - * Flag indicating whether delete should be implemented as a navigation item on the detail view controller. - */ -@property (nonatomic, assign) BOOL enableDetailViewDelete; - -/** - * Flag indicating whether thumbnail images are automatically downloaded and loading into LLInboxThumbnailCell. - * Defaults to YES. Set this property to NO to manually manage thumbnail downloading and caching (such as through - * a 3rd party networking library). - */ -@property (nonatomic, assign) BOOL downloadsThumbnails; - -/** - * The font of the UITableViewCell textLabel. Default is 16 point system bold. - */ -@property (nonatomic, strong, nonnull) UIFont *textLabelFont; - -/** - * The color of the UITableViewCell textLabel. Default is black. - */ -@property (nonatomic, strong, nonnull) UIColor *textLabelColor; - -/** - * The font of the UITableViewCell detailTextLabel. Default is 14 point system. - */ -@property (nonatomic, strong, nonnull) UIFont *detailTextLabelFont; - -/** - * The color of the UITableViewCell detailTextLabel. Default is black. - */ -@property (nonatomic, strong, nonnull) UIColor *detailTextLabelColor; - -/** - * The font of the UITableViewCell timeTextLabel. Default is 10 point system. - */ -@property (nonatomic, strong, nonnull) UIFont *timeTextLabelFont; - -/** - * The color of the UITableViewCell timeTextLabel. Default is gray. - */ -@property (nonatomic, strong, nonnull) UIColor *timeTextLabelColor; - -/** - * The color of the UITableViewCell unread indicator. Default is #007AFF. - */ -@property (nonatomic, strong, nonnull) UIColor *unreadIndicatorColor; - -/** - * The color of the UITablviewCell background - */ -@property (nonatomic, strong, nonnull) UIColor *cellBackgroundColor; - -/** - * The UIView to show when a creative fails to load in a detail view. This property is used to set the - * creativeLoadErrorView of LLInboxDetailViewControllers created when the user opens a campaign. - * If this property is not set, a gray 'X' will be shown in the center of the view. - * - * Note: All subviews of this view should include appropriate Auto Layout constraints because this - * view's leading edge, top edge, trailing edge, and bottom edge will be constrained to match - * the main view in LLInboxDetailViewController. - */ -@property (nonatomic, strong, nullable) UIView *creativeLoadErrorView; - -/** - * Returns the inbox campaign for an index path (useful for overriding tableView:cellForRowAtIndexPath:) - * - * @return An LLInboxCampaign object for the index path. - */ -- (nullable LLInboxCampaign *)campaignForRowAtIndexPath:(nonnull NSIndexPath *)indexPath; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLMarketingWebViewHandler.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLMarketingWebViewHandler.h deleted file mode 100644 index 120072b..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLMarketingWebViewHandler.h +++ /dev/null @@ -1,50 +0,0 @@ -#import - -@class LLWebViewCampaign; -@protocol LLLocalyticsDelegate; - -@protocol LLMarketingWebViewHandlerDelegate - -- (void)handlerDidFinishLoad; -- (void)handlerDidFailLoadWithError:(nullable NSError *)error; - -@optional -- (void)didHandleCloseRequest; - -@end - -@interface LLMarketingWebViewHandlerBuilder : NSObject - -@property (nonatomic, strong, nullable) WKWebView *webView; -@property (nonatomic, strong, nullable) LLWebViewCampaign *campaign; -@property (nonatomic, assign) BOOL openCustomURLSchemas; -@property (nonatomic, assign) BOOL loadUnknownURLSchemas; -@property (nonatomic, assign) CGFloat videoConversionPercentage; -@property (nonatomic, assign, getter=isTestModeEnabled) BOOL testModeEnabled; -@property (nonatomic, weak, nullable) id localyticsDelegate; -@property (nonatomic, assign, nonnull) NSString *creativeFilePath; - -+ (nonnull WKWebViewConfiguration *)webViewConfiguration:(nullable LLWebViewCampaign *)campaign - localyticsDelegate:(nonnull id)localyticsDelegate - andViewportWidth:(CGFloat)viewportWidth - withViewportFit:(nullable NSString *)viewportFit - videoConversionPercentage:(CGFloat)videoConversionPercentage; - -@end - -@interface LLMarketingWebViewHandler : NSObject - -@property (nonatomic, strong) WKWebView * __nullable webView; -@property (nonatomic, strong) __nullable id delegate; -//exposed for wrappers -@property (nonatomic, strong, nullable) LLWebViewCampaign *campaign; - -+ (nullable instancetype)marketingWebViewWithBlock:(nonnull void (^)(LLMarketingWebViewHandlerBuilder * __nonnull builder))block; - -- (BOOL)loadCreative; -- (void)tagMarketingActionForURL:(nonnull NSURL *)url andQueryParams:(nonnull NSDictionary *)queryParams; -- (void)tagMarketingDismissAction; -- (BOOL)creativeHtmlFileExists; -- (void)executeJs:(nonnull NSString*)js; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLPlacesCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLPlacesCampaign.h deleted file mode 100644 index 2880394..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLPlacesCampaign.h +++ /dev/null @@ -1,60 +0,0 @@ -// -// LLPlacesCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -@class LLRegion; - -/** - * The campaign class containing information relevant to a single places campaign. - * - * @see LLCampaignBase - */ -@interface LLPlacesCampaign : LLCampaignBase -// Make sure to override all properties in copyWithZone! - -/** - * The push message - */ -@property (nonatomic, copy, readonly, nonnull) NSString *message; - -/** - * The sound filename of the UILocalNotification - */ -@property (nonatomic, copy, readonly, nullable) NSString *soundFilename; - -/** - * The region object associated with this campaign - */ -@property (nonatomic, copy, readonly, nonnull) LLRegion *region; - -/** - * The event which triggered this campaign - */ -@property (nonatomic, assign, readonly) LLRegionEvent event; - -/** - * The category for the local notification - */ -@property (nonatomic, copy, readonly, nullable) NSString *category; - -/** - * The attachment URL for the UNNotificationAttachment - */ -@property (nonatomic, copy, readonly, nullable) NSString *attachmentURL; - -/** - * The attachment URL type for the UNNotificationAttachment - */ -@property (nonatomic, copy, readonly, nullable) NSString *attachmentType; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLRegion.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLRegion.h deleted file mode 100644 index e925396..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLRegion.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// LLRegion.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import - -/** - * A base region class containing information relevant to all region types - */ -@interface LLRegion : NSObject - -/** - * The name of the region - */ -@property (nonatomic, copy, readonly, nullable) NSString *name; - -/** - * The attributes associated with the region - */ -@property (nonatomic, copy, readonly, nullable) NSDictionary *attributes; - -/** - * The Core Location region object associated with this region - */ -@property (nonatomic, copy, readonly, nonnull) CLRegion *region; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLWebViewCampaign.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLWebViewCampaign.h deleted file mode 100644 index 70728c8..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LLWebViewCampaign.h +++ /dev/null @@ -1,28 +0,0 @@ -// -// LLWebViewCampaign.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -/** - * A base campaign class containing information relevant to campaigns which - * include a web component. - * - * @see LLCampaignBase - */ -@interface LLWebViewCampaign : LLCampaignBase -// Make sure to override all properties in copyWithZone! - -/** - * The file path on disk of the creative associated with this campaign. - */ -@property (nonatomic, copy, readonly, nullable) NSString *creativeFilePath; - -@end diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics-Framework.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics-Framework.h deleted file mode 100644 index 7b2002d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics-Framework.h +++ /dev/null @@ -1,20 +0,0 @@ -// -// Localytics-Framework.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import - -//! Project version number for Localytics. -FOUNDATION_EXPORT double LocalyticsVersionNumber; - -//! Project version string for Localytics. -FOUNDATION_EXPORT const unsigned char LocalyticsVersionString[]; - -#import diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics.h deleted file mode 100644 index dd0e67d..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/Localytics.h +++ /dev/null @@ -1,1667 +0,0 @@ -// -// Localytics.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - -#import -#import -#import -#import -/* - Analytics Delegate -*/ -@protocol LLAnalyticsDelegate; - -#if !TARGET_OS_TV - -#import -#import -#import -#import -#import -#import -#import -#import -#import -#import -#import - -@protocol LLMessagingDelegate; -@protocol LLCallToActionDelegate; -@protocol LLLocationDelegate; - -@class WKWebViewConfiguration; -@class UNMutableNotificationContent; -#define LOCALYTICS_LIBRARY_VERSION @"6.2.9" //iOS version - -#else - -#define LOCALYTICS_LIBRARY_VERSION @"1.0.2" //tvOS version - -#endif - - -@protocol Localytics -#if TARGET_OS_TV - -#endif - -#pragma mark - SDK Integration -/** --------------------------------------------------------------------------------------- - * @name Localytics SDK Integration - * --------------------------------------------------------------------------------------- - */ - -/** Auto-integrates the Localytic SDK into the application. - - Use this method to automatically integrate the Localytics SDK in a single line of code. Automatic - integration is accomplished by proxying the AppDelegate and "inserting" a Localytics AppDelegate - behind the applications AppDelegate. The proxy will first call the applications AppDelegate and - then call the Localytics AppDelegate. - - @param appKey The unique key for each application generated at www.localytics.com - @param localyticsOptions A dictionary containing intervals for uploading data based on connection type. - If set to nil, defaults will be used. - @param launchOptions The launchOptions provided by application:DidFinishLaunchingWithOptions: - - @see LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS - - @Version SDK5.0 - */ -+ (void)autoIntegrate:(nonnull NSString *)appKey withLocalyticsOptions:(nullable NSDictionary *)localyticsOptions launchOptions:(nullable NSDictionary *)launchOptions NS_AVAILABLE_IOS(9_0); - -/** Manually integrate the Localytic SDK into the application. - - Use this method to manually integrate the Localytics SDK. The developer still has to make sure to - open and close the Localytics session as well as call upload to ensure data is uploaded to - Localytics - - @param appKey The unique key for each application generated at www.localytics.com - @param localyticsOptions A dictionary containing intervals for uploading data based on connection type. - If set to nil, defaults will be used. - @see openSession - @see closeSession - @see upload - @see LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS - @see LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS - - @Version SDK5.0 - */ -+ (void)integrate:(nonnull NSString *)appKey withLocalyticsOptions:(nullable NSDictionary *)localyticsOptions NS_AVAILABLE_IOS(9_0); - -/** Opens the Localytics session. - The session time as presented on the website is the time between open and the - final close so it is recommended to open the session as early as possible, and close - it at the last moment. It is recommended that this call be placed in applicationDidBecomeActive. -
- If for any reason this is called more than once every subsequent open call will be ignored. - - Resumes the Localytics session. When the App enters the background, the session is - closed and the time of closing is recorded. When the app returns to the foreground, the session - is resumed. If the time since closing is greater than BACKGROUND_SESSION_TIMEOUT, (15 seconds - by default) a new session is created, and uploading is triggered. Otherwise, the previous session - is reopened. - - * @Version SDK3.0 - */ -+ (void)openSession NS_AVAILABLE_IOS(9_0); - -/** Closes the Localytics session. This should be called in - applicationWillResignActive. -
- If close is not called, the session will still be uploaded but no - events will be processed and the session time will not appear. This is - because the session is not yet closed so it should not be used in - comparison with sessions which are closed. - - @Version SDK3.0 - */ -+ (void)closeSession NS_AVAILABLE_IOS(9_0); - -/** Creates a low priority thread which uploads any Localytics data already stored - on the device. This should be done early in the process life in order to - guarantee as much time as possible for slow connections to complete. It is also reasonable - to upload again when the application is exiting because if the upload is cancelled the data - will just get uploaded the next time the app comes up. - - @Version SDK3.0 - */ -+ (void)upload NS_AVAILABLE_IOS(9_0); - -/** - Halt the uploading of Analytics and Profiles data to the Localytics servers. - Re-enabling the upload of data will cause an immediate upload. - - @Version SDK5.1 - @param pause if set to true, all data uploading will be halted. If false, data uploading will resume as normal. - */ - -+ (void)pauseDataUploading:(BOOL)pause NS_AVAILABLE_IOS(9_0); - -#pragma mark - Event Tagging -/** --------------------------------------------------------------------------------------- - * @name Event Tagging - * --------------------------------------------------------------------------------------- - */ - -/** Tag an event - @param eventName The name of the event which occurred. - @see tagEvent:attributes:customerValueIncrease: - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName NS_AVAILABLE_IOS(9_0); - -/** Tag an event with attributes - @param eventName The name of the event which occurred. - @param attributes An object/hash/dictionary of key-value pairs, contains - contextual data specific to the event. - @see tagEvent:attributes:customerValueIncrease: - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** Allows a session to tag a particular event as having occurred. For - example, if a view has three buttons, it might make sense to tag - each button click with the name of the button which was clicked. - For another example, in a game with many levels it might be valuable - to create a new tag every time the user gets to a new level in order - to determine how far the average user is progressing in the game. -
- Tagging Best Practices -
    -
  • DO NOT use tags to record personally identifiable information.
    • -
  • The best way to use tags is to create all the tag strings as predefined - constants and only use those. This is more efficient and removes the risk of - collecting personal information.
    • -
  • Do not set tags inside loops or any other place which gets called - frequently. This can cause a lot of data to be stored and uploaded.
    • -
-
- See the tagging guide at: http://docs.localytics.com/dev/ios.html#events-ios - @param eventName The name of the event which occurred. - @param attributes (Optional) An object/hash/dictionary of key-value pairs, contains - contextual data specific to the event. - @param customerValueIncrease (Optional) Numeric value, added to customer lifetime value. - Integer expected. Try to use lowest possible unit, such as cents for US currency. - - @Version SDK3.0 - */ -+ (void)tagEvent:(nonnull NSString *)eventName attributes:(nullable NSDictionary *)attributes customerValueIncrease:(nullable NSNumber *)customerValueIncrease NS_AVAILABLE_IOS(9_0); - -#pragma mark - Standard Event Tagging -/** --------------------------------------------------------------------------------------- - * @name Standard Event Tagging - * --------------------------------------------------------------------------------------- - */ - -/** - * A standard event to tag a single item purchase event (after the action has occurred) - * - * @param itemName The name of the item purchased (optional, can be null) - * @param itemId A unique identifier of the item being purchased, such as a SKU (optional, can be null) - * @param itemType The type of item (optional, can be null) - * @param itemPrice The price of the item (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency. - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagPurchased:(nullable NSString *)itemName itemId:(nullable NSString *)itemId itemType:(nullable NSString *)itemType itemPrice:(nullable NSNumber *)itemPrice attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the addition of a single item to a cart (after the action has occurred) - * - * @param itemName The name of the item purchased (optional, can be null) - * @param itemId A unique identifier of the item being purchased, such as a SKU (optional, can be null) - * @param itemType The type of item (optional, can be null) - * @param itemPrice The price of the item (optional, can be null). Will NOT be added to customer lifetime value. - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagAddedToCart:(nullable NSString *)itemName itemId:(nullable NSString *)itemId itemType:(nullable NSString *)itemType itemPrice:(nullable NSNumber *)itemPrice attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the start of the checkout process (after the action has occurred) - * - * @param totalPrice The total price of all the items in the cart (optional, can be null). Will NOT be added to customer lifetime value. - * @param itemCount Total count of items in the cart (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagStartedCheckout:(nullable NSNumber *)totalPrice itemCount:(nullable NSNumber *)itemCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the conclusions of the checkout process (after the action has occurred) - * - * @param totalPrice The total price of all the items in the cart (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency. - * @param itemCount Total count of items in the cart (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCompletedCheckout:(nullable NSNumber *)totalPrice itemCount:(nullable NSNumber *)itemCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the viewing of content (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagContentViewed:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a search event (after the action has occurred) - * - * @param queryText The query user for the search (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param resultCount The number of results returned by the query (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagSearched:(nullable NSString *)queryText contentType:(nullable NSString *)contentType resultCount:(nullable NSNumber *)resultCount attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a share event (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param methodName The method by which the content was shared such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagShared:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the rating of content (after the action has occurred) - * - * @param contentName The name of the content being viewed (such as article name) (optional, can be null) - * @param contentId A unique identifier of the content being viewed (optional, can be null) - * @param contentType The type of content (optional, can be null) - * @param rating A rating of the content (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagContentRated:(nullable NSString *)contentName contentId:(nullable NSString *)contentId contentType:(nullable NSString *)contentType rating:(nullable NSNumber *)rating attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the registration of a user (after the action has occurred) - * - * @param customer An object providing information about the customer that registered (optional, can be null) - * @param methodName The method by which the user was registered such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerRegistered:(nullable LLCustomer *)customer methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the logging in of a user (after the action has occurred) - * - * @param customer An object providing information about the customer that logged in (optional, can be null) - * @param methodName The method by which the user was logged in such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerLoggedIn:(nullable LLCustomer *)customer methodName:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the logging out of a user (after the action has occurred) - * - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagCustomerLoggedOut:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag the invitation of a user (after the action has occured) - * - * @param methodName The method by which the user was invited such as Twitter, Facebook, Native (optional, can be null) - * @param attributes Any additional attributes to attach to this event (optional, can be null) - * - * @Version SDK4.0 - */ -+ (void)tagInvited:(nullable NSString *)methodName attributes:(nullable NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -#pragma mark - Tag Screen Method - -/** Allows tagging the flow of screens encountered during the session. - @param screenName The name of the screen - - @Version SDK3.0 - */ -+ (void)tagScreen:(nonnull NSString *)screenName NS_AVAILABLE_IOS(9_0); - -#pragma mark - Custom Dimensions -/** --------------------------------------------------------------------------------------- - * @name Custom Dimensions - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a custom dimension. Custom dimensions are dimensions - which contain user defined data unlike the predefined dimensions such as carrier, model, and country. - Once a value for a custom dimension is set, the device it was set on will continue to upload that value - until the value is changed. To clear a value pass nil as the value. - The proper use of custom dimensions involves defining a dimension with less than ten distinct possible - values and assigning it to one of the four available custom dimensions. Once assigned this definition should - never be changed without changing the App Key otherwise old installs of the application will pollute new data. - @param value The value to set the custom dimension to - @param dimension The dimension to set the value of - @see valueForCustomDimension: - - @Version SDK3.0 - */ -+ (void)setValue:(nullable NSString *)value forCustomDimension:(NSUInteger)dimension NS_AVAILABLE_IOS(9_0); - -/** Gets the custom value for a given dimension. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @param dimension The custom dimension to return a value for - @return The current value for the given custom dimension - @see setValue:forCustomDimension: - - @Version SDK3.0 - */ -+ (nullable NSString *)valueForCustomDimension:(NSUInteger)dimension NS_AVAILABLE_IOS(9_0); - -#pragma mark - Identifiers -/** --------------------------------------------------------------------------------------- - * @name Identifiers - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a custom identifier. Identifiers are a form of key/value storage - which contain custom user data. Identifiers might include things like email addresses, - customer IDs, twitter handles, and facebook IDs. Once a value is set, the device it was set - on will continue to upload that value until the value is changed. - To delete a property, pass in nil as the value. - @param value The value to set the identifier to. To delete a propert set the value to nil - @param identifier The name of the identifier to have it's value set - @see valueForIdentifier: - - @Version SDK3.0 - */ -+ (void)setValue:(nullable NSString *)value forIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Gets the identifier value for a given identifier. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @param identifier The identifier to return a value for - @return The current value for the given identifier - @see setValue:forCustomDimension: - - @Version SDK3.0 - */ -+ (nullable NSString *)valueForIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Set the identifier for the customer. This value is used when setting profile attributes, - targeting users for push and mapping data exported from Localytics to a user. - @param customerId The value to set the customer identifier to - - @Version SDK3.0 - */ -+ (void)setCustomerId:(nullable NSString *)customerId NS_AVAILABLE_IOS(9_0); - -/** Set the identifier for the customer. This value is used when setting profile attributes, - targeting users for push and mapping data exported from Localytics to a user. - Additionally this will set the appropriate data collection state for the the user. - @param customerId The value to set the customer identifier to - @param optedOut If the user has consented to data collection - @see setCustomerId: - @see setPrivacyOptedOut: - - @Version SDK5.1 - */ -+ (void)setCustomerId:(nullable NSString *)customerId privacyOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Gets the customer id. Avoid calling this on the main thread, as it - may take some time for all pending database execution. - @return The current value for customer id - - @Version SDK3.1.0 - */ -+ (nullable NSString *)customerId NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Profile -/** --------------------------------------------------------------------------------------- - * @name Profile - * --------------------------------------------------------------------------------------- - */ - -/** Sets the value of a profile attribute. - @param value The value to set the profile attribute to. value can be one of the following: NSString, - NSNumber(long & int), NSDate, NSArray of Strings, NSArray of NSNumbers(long & int), NSArray of Date, - nil. Passing in a 'nil' value will result in that attribute being deleted from the profile - @param attribute The name of the profile attribute to be set - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)setValue:(nonnull id)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Sets the value of a profile attribute (scope: Application). - @param value The value to set the profile attribute to. value can be one of the following: NSString, - NSNumber(long & int), NSDate, NSArray of Strings, NSArray of NSNumbers(long & int), NSArray of Date, - nil. Passing in a 'nil' value will result in that attribute being deleted from the profile - @param attribute The name of the profile attribute to be set - - @Version SDK3.0 - */ -+ (void)setValue:(nonnull id)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Adds values to a profile attribute that is a set - @param values The value to be added to the profile attributes set. - @param attribute The name of the profile attribute to have it's set modified - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)addValues:(nonnull NSArray *)values toSetForProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Adds values to a profile attribute that is a set (scope: Application). - @param values The value to be added to the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - - @Version SDK3.0 - */ -+ (void)addValues:(nonnull NSArray *)values toSetForProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Removes values from a profile attribute that is a set - @param values The value to be removed from the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)removeValues:(nonnull NSArray *)values fromSetForProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Removes values from a profile attribute that is a set (scope: Application). - @param values The value to be removed from the profile attributes set - @param attribute The name of the profile attribute to have it's set modified - - @Version SDK3.0 - */ -+ (void)removeValues:(nonnull NSArray *)values fromSetForProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Increment the value of a profile attribute. - @param value An NSInteger to be added to an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value incremented - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)incrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Increment the value of a profile attribute (scope: Application). - @param value An NSInteger to be added to an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value incremented - - @Version SDK3.0 - */ -+ (void)incrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Decrement the value of a profile attribute. - @param value An NSInteger to be subtracted from an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value decremented - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)decrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Decrement the value of a profile attribute (scope: Application). - @param value An NSInteger to be subtracted from an existing profile attribute value. - @param attribute The name of the profile attribute to have it's value decremented - - @Version SDK3.0 - */ -+ (void)decrementValueBy:(NSInteger)value forProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Delete a profile attribute - @param attribute The name of the attribute to be deleted - @param scope The scope of the attribute governs the visability of the profile attribute (application - only or organization wide) - - @Version SDK3.0 - */ -+ (void)deleteProfileAttribute:(nonnull NSString *)attribute withScope:(LLProfileScope)scope NS_AVAILABLE_IOS(9_0); - -/** Delete a profile attribute (scope: Application) - @param attribute The name of the attribute to be deleted - - @Version SDK3.0 - */ -+ (void)deleteProfileAttribute:(nonnull NSString *)attribute NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's email as both a profile attribute and - as a customer identifier (scope: Organization) - @param email Customer's email - - @Version SDK3.3.0 - */ -+ (void)setCustomerEmail:(nullable NSString *)email NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's first name as both a profile attribute and - as a customer identifier (scope: Organization) - @param firstName Customer's first name - - @Version SDK3.3.0 - */ -+ (void)setCustomerFirstName:(nullable NSString *)firstName NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's last name as both a profile attribute and - as a customer identifier (scope: Organization) - @param lastName Customer's last name - - @Version SDK3.3.0 - */ -+ (void)setCustomerLastName:(nullable NSString *)lastName NS_AVAILABLE_IOS(9_0); - -/** Convenience method to set a customer's full name as both a profile attribute and - as a customer identifier (scope: Organization) - @param fullName Customer's full name - - @Version SDK3.3.0 - */ -+ (void)setCustomerFullName:(nullable NSString *)fullName NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Developer Options -/** --------------------------------------------------------------------------------------- - * @name Developer Options - * --------------------------------------------------------------------------------------- - */ - -/** - * Customize the behavior of the SDK by setting custom values for various options. - * In each entry, the key specifies the option to modify, and the value specifies what value - * to set the option to. Options can be restored to default by passing in a value of NSNull, - * or an empty string for values with type NSString. - * @param options The dictionary of options and values to modify - * - * @Version SDK4.0 - */ -+ (void)setOptions:(nullable NSDictionary *)options NS_AVAILABLE_IOS(9_0); - -/** Returns whether the Localytics SDK is set to emit logging information - @return YES if logging is enabled, NO otherwise - - @Version SDK3.0 - */ -+ (BOOL)isLoggingEnabled NS_AVAILABLE_IOS(9_0); - -/** Set whether Localytics SDK should emit logging information. By default the Localytics SDK - is set to not to emit logging information. It is recommended that you only enable logging - for debugging purposes. - @param loggingEnabled Set to YES to enable logging or NO to disable it - - @Version SDK3.0 - */ -+ (void)setLoggingEnabled:(BOOL)loggingEnabled NS_AVAILABLE_IOS(9_0); - -/** Tell the Localytics SDK to keep a copy of all logs in a file on disk. - It is recommended that you only enable logging for debugging purposes. - - @Version SDK5.0 - */ -+ (void)redirectLoggingToDisk NS_AVAILABLE_IOS(9_0); - -/** Returns whether or not the application will collect user data. - @return YES if the user is opted out, NO otherwise. Default is NO - @see setOptedOut: - - @Version SDK3.0 - */ -+ (BOOL)isOptedOut NS_AVAILABLE_IOS(9_0); - -/** Allows the application to control whether or not it will collect user data. - Even if this call is used, it is necessary to continue calling upload(). No new data will be - collected, so nothing new will be uploaded but it is necessary to upload an event telling the - server this user has opted out. - @param optedOut YES if the user is opted out, NO otherwise. - @see isOptedOut - - @Version SDK3.0 - */ -+ (void)setOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Returns whether or not the application will collect user data. - @return YES if the user is opted out, NO otherwise. Default is NO - @see setPrivacyOptedOut: - - @Version SDK5.1 - */ -+ (BOOL)isPrivacyOptedOut NS_AVAILABLE_IOS(9_0); - -/** Sets the Localytics opt-out state for this application. This call is not necessary and is provided for people who wish to - allow their users the ability to opt out of data collection. It can be called at any time. Passing true causes all further - data collection to stop, and a profile attribute will be set causing a deletion of data request to be made for Localytics - in line with the GDPR standard. - There are very serious implications to the quality of your data when providing an opt out option. For example, users who - have opted out will appear as never returning, causing your new/returning chart to skew.
- As a side effect of protecting a user's data, the SDK will internally ensure that ADID's are - no longer appended to the url's of In-App and Inbox call to action links. - @param optedOut YES if the user is opted out, NO otherwise. - @see isPrivacyOptedOut - - @Version SDK5.1 - */ -+ (void)setPrivacyOptedOut:(BOOL)optedOut NS_AVAILABLE_IOS(9_0); - -/** Returns the install id - @return the install id as an NSString - - @Version SDK3.0 - */ -+ (nullable NSString *)installId NS_AVAILABLE_IOS(9_0); - -/** Returns the version of the Localytics SDK - @return the version of the Localytics SDK as an NSString - - @Version SDK3.0 - */ -+ (nonnull NSString *)libraryVersion NS_AVAILABLE_IOS(9_0); - -/** Returns the app key currently set in Localytics - @return the app key currently set in Localytics as an NSString - - @Version SDK3.0 - */ -+ (nullable NSString *)appKey NS_AVAILABLE_IOS(9_0); - -/** Returns whether the Localytics SDK is currently in test mode or not. When in test mode - a small Localytics tab will appear on the left side of the screen which enables a developer - to see/test all the campaigns currently available to this customer. - @return YES if test mode is enabled, NO otherwise - - @Version SDK3.0 - */ -+ (BOOL)isTestModeEnabled NS_AVAILABLE_IOS(9_0); - -/** Set whether Localytics SDK should enter test mode or not. When set to YES the a small - Localytics tab will appear on the left side of the screen, enabling a developer to see/test - all campaigns currently available to this customer. - Setting testModeEnabled to NO will cause Localytics to exit test mode, if it's currently - in it. - @param enabled Set to YES to enable test mode, NO to disable test mode - - @Version SDK4.0 - */ -+ (void)setTestModeEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** - Enter live device logging mode. - - @Version SDK5.5 - */ -+ (void)enableLiveDeviceLogging NS_AVAILABLE_IOS(9_0); - -#pragma mark - Permission Prompts -/** - Request IDFA Permissions - - @Version SDK6.1 - */ -+ (BOOL)requestAdvertisingIdentifierPrompt NS_AVAILABLE_IOS(14_0); - -/** - Get IDFA Permission status - - @Version SDK6.1 - */ -+ (LLAdIdStatus)advertisingIdentifierStatus NS_AVAILABLE_IOS(14_0); - -#pragma mark - Analytics Delegate -/** --------------------------------------------------------------------------------------- - * @name Analytics Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set an Analytics delegate - @param delegate An object implementing the LLAnalyticsDelegate protocol. - @see LLAnalyticsDelegate - - @Version SDK3.0 - */ -+ (void)setAnalyticsDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Stores the user's location. This will be used in all event and session calls. - If your application has already collected the user's location, it may be passed to Localytics - via this function. This will cause all events and the session close to include the location - information. It is not required that you call this function. - @param location The user's location. - - @Version SDK3.0 - */ -+ (void)setLocation:(CLLocationCoordinate2D)location NS_AVAILABLE_IOS(9_0); - -#if !TARGET_OS_TV - -#pragma mark - Push -/** --------------------------------------------------------------------------------------- - * @name Push - * --------------------------------------------------------------------------------------- - */ - -/** Returns the device's APNS token if one has been set via setPushToken: previously. - @return The device's APNS token if one has been set otherwise nil - @see setPushToken: - - @Version SDK3.0 - */ -+ (nullable NSString *)pushToken NS_AVAILABLE_IOS(9_0); - -/** Stores the device's APNS token. This will be used in all event and session calls. - @param pushToken The devices APNS token returned by application:didRegisterForRemoteNotificationsWithDeviceToken: - @see pushToken - - @Version SDK3.0 - */ -+ (void)setPushToken:(nullable NSData *)pushToken NS_AVAILABLE_IOS(9_0); - -/** Used to record performance data for notifications, both Localytics Push Received and Push Opened. - With the introduction of UserNotifications in iOS 10, this method has been deprecated in favor of calling - handleNotificationReceived: for push received reporting and didReceiveNotificationResponseWithUserInfo: for push opened reporting. - @param notificationInfo The dictionary from either didFinishLaunchingWithOptions, didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - - @Version SDK4.0 - */ -+ (void)handleNotification:(nonnull NSDictionary *)notificationInfo NS_DEPRECATED_IOS(9_0, 10_0); - -/** Used to record performance data for notifications - @param notificationInfo The dictionary from either didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - - @Version SDK5.5 - */ -+ (void)handleNotificationReceived:(nonnull NSDictionary *)notificationInfo NS_AVAILABLE_IOS(10_0); - - -/** Used to record performance data for notifications with action identifiers - @param notificationInfo The dictionary from either didFinishLaunchingWithOptions, didReceiveRemoteNotification, - or didReceiveLocalNotification should be passed on to this method - @param identifier The specific notification action associated with the opened push notification. - - @Version SDK4.4.0 - */ -+ (void)handleNotification:(nonnull NSDictionary *)notificationInfo withActionIdentifier:(nullable NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** Use to record performance data for notifications when using UNUserNotificationCenterDelegate - @param userInfo The UNNotificationResponse's userInfo retrieved by calling response.notification.request.content.userInfo - - @Version SDK4.1.0 - */ -+ (void)didReceiveNotificationResponseWithUserInfo:(nonnull NSDictionary *)userInfo NS_AVAILABLE_IOS(10_0); - -/** Use to record performance data for notifications when using UNUserNotificationCenterDelegate and a specific notification action was selected. - @param userInfo The UNNotificationResponse's userInfo retrieved by calling response.notification.request.content.userInfo - @param identifier The UNNotificationResponse's actionIdentifier retrieved by calling response.actionIdentifier - - @Version SDK4.4.0 - */ -+ (void)didReceiveNotificationResponseWithUserInfo:(nonnull NSDictionary *)userInfo andActionIdentifier:(nullable NSString *)identifier NS_AVAILABLE_IOS(10_0); - -/** Used to notify the Localytics SDK that notification settings have changed - - * @Version SDK5.0 - */ -+ (void)didRegisterUserNotificationSettings NS_AVAILABLE_IOS(9_0); - -/** Used to notify the Localytics SDK that user notification authorization has changed - * - * @param options The options used to request notification authorization - * @param granted The user's response to the notification request. - * @Version SDK4.1.0 - */ -+ (void)didRequestUserNotificationAuthorizationWithOptions:(NSUInteger)options granted:(BOOL)granted NS_AVAILABLE_IOS(9_0); - -#pragma mark - In-App Message -/** --------------------------------------------------------------------------------------- - * @name In-App Message - * --------------------------------------------------------------------------------------- - */ - -/** - @param url The URL to be handled - @return YES if the URL was successfully handled or NO if the attempt to handle the - URL failed. - - * @Version SDK3.0 - */ -+ (BOOL)handleTestModeURL:(nonnull NSURL *)url NS_AVAILABLE_IOS(9_0); - -/** Set the image to be used for dimissing an In-App message - @param image The image to be used for dismissing an In-App message. By default this is a - circle with an 'X' in the middle of it - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonImage:(nullable UIImage *)image NS_AVAILABLE_IOS(9_0); - -/** Set the image to be used for dimissing an In-App message by providing the name of the - image to be loaded and used - @param imageName The name of an image to be loaded and used for dismissing an In-App - message. By default the image is a circle with an 'X' in the middle of it - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonImageWithName:(nullable NSString *)imageName NS_AVAILABLE_IOS(9_0); - -/** Set the location of the dismiss button on an In-App msg - @param location The location of the button (left or right) - @see LLInAppMessageDismissButtonLocation - - @Version SDK3.0 - */ -+ (void)setInAppMessageDismissButtonLocation:(LLInAppMessageDismissButtonLocation)location NS_AVAILABLE_IOS(9_0); - -/** Returns the location of the dismiss button on an In-App msg - @return LLInAppMessageDismissButtonLocation - @see LLInAppMessageDismissButtonLocation - - @Version SDK3.0 - */ -+ (LLInAppMessageDismissButtonLocation)inAppMessageDismissButtonLocation NS_AVAILABLE_IOS(9_0); - -/** Set the dismiss button hidden state on an In-App message - * @param hidden The hidden state of the dismiss button - * - * @Version SDK4.3.0 - */ -+ (void)setInAppMessageDismissButtonHidden:(BOOL)hidden NS_AVAILABLE_IOS(9_0); - -/** - Trigger an In-App message - - @param triggerName The name of the In-App message trigger - - @Version SDK3.0 - */ -+ (void)triggerInAppMessage:(nonnull NSString *)triggerName NS_AVAILABLE_IOS(9_0); - -/** - Trigger an In-App message - - @param triggerName The name of the In-App message trigger - @param attributes The attributes associated with the In-App triggering event - - @Version SDK3.0 - */ -+ (void)triggerInAppMessage:(nonnull NSString *)triggerName withAttributes:(nonnull NSDictionary *)attributes NS_AVAILABLE_IOS(9_0); - -/** - Trigger campaigns as if a Session Start event had just occurred. - - This is useful for integrations that want to delay presentation - of startup campaigns due to some startup state, such as a splash screen. - In order to delay the triggering, implement - LLMessagingListener and respond appropriately to - [LLMessagingListener localyticsShouldDelaySessionStartInAppMessages]. - Finally, once the start up state has cleared, call this method to trigger In-App - campaigns as if a session had just been started. - - @Version SDK4.3.0 - */ -+ (void)triggerInAppMessagesForSessionStart NS_AVAILABLE_IOS(9_0); - -/** - * If an In-App message is currently displayed, dismiss it. Is a no-op otherwise. - - * @Version SDK3.0 - */ -+ (void)dismissCurrentInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an In-App impression - * - * @param campaign The In-App campaign for which to tag an impression - * @param impressionType an enum of LLImpressionTypeClick or LLImpressionTypeDismiss - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInAppCampaign:(nonnull LLInAppCampaign *)campaign - withType:(LLImpressionType)impressionType NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an In-App impression. - * This method should be used when the standard methods are not intended. If a standard - * impression is desirable use [Localytics tagInAppImpression:withImpressionType:} - * - * Any NSString value passed in that is not equal to 'X' will result in a click on the dashboard. - * If an empty NSString is passed in, a dismiss impression will be tagged. - * - * @param campaign The In-App campaign for which to tag an impression - * @param customAction an NSString to tag the impression with. - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInAppCampaign:(nonnull LLInAppCampaign *)campaign - withCustomAction:(nonnull NSString *)customAction NS_AVAILABLE_IOS(9_0); - - -/** -Trigger an In-App message, forcing it to display immediately. - -This method is useful for certain use cases such as onboarding, where a message should -be shown to a user immediately, and all rules, such as frequency capping, audience -segmentation, and triggering logic can be ignored. - - No In-App will be shown if: - -* An In-App is already displaying - -* The specified campaign ID and/or creative ID don't match a valid campaign - -* The specified campaign ID and/or creative ID don't apply to this application key - -@param campaignId The In-App campaign ID, as defined in the Localytics Dashboard, for which to force an In-App -@param creativeId The In-App creative ID, as defined in the Localytics Dashboard, for which to force an In-App - -@Version SDK6.2.0 -*/ -+ (void)forceInAppMessageDisplay:(nonnull NSString *)campaignId forCreative:(nonnull NSString *)creativeId; - -/** -Trigger an In-App message, forcing it to display immediately. - -This method is useful for certain use cases such as onboarding, where a message should -be shown to a user immediately, and all rules, such as frequency capping, audience -segmentation, and triggering logic can be ignored. - - No In-App will be shown if: - -* An In-App is already displaying - -* The specified url is not a local file - -* The specified url points to an empty file - -@param localFileUrl The absolute file path to a local file - -@Version SDK6.2.0 -*/ -+ (void)forceInAppMessageDisplay:(nonnull NSURL *)localFileUrl; - -#pragma mark - Inbox - -/** Returns an array of all Inbox campaigns that are enabled and can be displayed. - @return an array of LLInboxCampaign objects - - @Version SDK5.2.0 - */ -+ (nonnull NSArray *)displayableInboxCampaigns NS_AVAILABLE_IOS(9_0); - -/** Returns an array of all Inbox campaigns that are enabled. The return value will include Inbox - campaigns with no listing title, and thus no visible UI element as well as deleted Inbox campaigns. - @return an array of LLInboxCampaign objects - - @Version SDK4.4.0 - */ -+ (nonnull NSArray *)allInboxCampaigns NS_AVAILABLE_IOS(9_0); - -/** Refresh inbox campaigns from the Localytics server that are enabled and can be displayed. - @param completionBlock the block invoked with refresh is complete - - @Version SDK3.7.0 - */ -+ (void)refreshInboxCampaigns:(nonnull void (^)(NSArray * _Nullable inboxCampaigns))completionBlock NS_AVAILABLE_IOS(9_0); - -/** Refresh inbox campaigns from the Localytics server that are enabled. The return value will - include Inbox campaigns with no listing title, and thus no visible UI element as well as deleted Inbox campaigns. - @param completionBlock the block invoked with refresh is complete - - @Version SDK4.4.0 - */ -+ (void)refreshAllInboxCampaigns:(nonnull void (^)(NSArray * _Nullable inboxCampaigns))completionBlock NS_AVAILABLE_IOS(9_0); - -/** Set an Inbox campaign as read. Read state can be used to display opened but not disabled Inbox - campaigns differently (e.g. greyed out). - @param campaign an LLInboxCampaign that should have its read flag changed. - @param read YES to mark the campaign as read, NO to mark it as unread - @see LLInboxCampaign - - @Version SDK4.4.0 - */ -+ (void)setInboxCampaign:(nonnull LLInboxCampaign *)campaign asRead:(BOOL)read NS_AVAILABLE_IOS(9_0); - -/** Set an Inbox campaign as deleted. Deleted Inbox campaigns will not be returned from - the list of visible inbox campaigns. - @param campaign an LLInboxCampaign that should be deleted - @see LLInboxCampaign - - @Version SDK5.2.0 - */ -+ (void)deleteInboxCampaign:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** Get the count of unread inbox messages - @return the count of unread inbox messages - - @Version SDK4.0 - */ -+ (NSInteger)inboxCampaignsUnreadCount NS_AVAILABLE_IOS(9_0); - -/** Returns a inbox campaign detail view controller with the given inbox campaign data. - * @param campaign The INbox campaign for which to retrieve an Inbox detail ViewController. - * @return a LLInboxDetailViewController from a given LLInboxCampaign object - * - @Version SDK3.7.0 - */ -+ (nonnull LLInboxDetailViewController *)inboxDetailViewControllerForCampaign:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an Inbox impression - * - * @param campaign The Inbox campaign for which to tag an impression - * @param impressionType an enum of LLImpressionTypeClick or LLImpressionTypeDismiss - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInboxCampaign:(nonnull LLInboxCampaign *)campaign - withType:(LLImpressionType)impressionType NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag an Inbox impression. - * This method should be used when the standard methods are not intended. If a standard - * impression is desirable use [Localytics tagInboxImpression:withImpressionType:} - * - * Any NSString value passed in that is not equal to 'X' will result in a click on the dashboard. - * If an empty NSString is passed in, a dismiss impression will be tagged. - * - * @param campaign The Inbox campaign for which to tag an impression - * @param customAction an NSString to tag the impression with. - * - * @Version SDK4.3.1 - */ -+ (void)tagImpressionForInboxCampaign:(nonnull LLInboxCampaign *)campaign - withCustomAction:(nonnull NSString *)customAction NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Push to Inbox impression. - * - * @param campaign The Inbox campaign for which to tag an impression - * @param success Whether or not the deep link was successful - * - * @Version SDK4.4.0 - */ -+ (void)tagImpressionForPushToInboxCampaign:(nonnull LLInboxCampaign *)campaign - success:(BOOL)success NS_AVAILABLE_IOS(9_0); - -/** - * Tell the Localytics SDK that an Inbox campaign was tapped in the list view. - * - * @param campaign The Inbox campaign that was tapped in the list view. - * - * @Version SDK4.4.0 - */ -+ (void)inboxListItemTapped:(nonnull LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * FOR LOCALYTICS WRAPPER USE ONLY - * - * @param webViewConfig The WebViewConfiguration responsible for handling webview events - * @param campaign The Inbox campaign that will be displayed - * - * @Version SDK5.4.1 - */ -+ (void)setupWebViewConfiguration:(nonnull WKWebViewConfiguration *)webViewConfig withCampaign:(nullable LLInboxCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * FOR LOCALYTICS WRAPPER USE ONLY - * - * @Version SDK5.4.1 - */ -+ (nullable LLMarketingWebViewHandler *)marketingWebViewHandler NS_AVAILABLE_IOS(9_0); - -#pragma mark - Location - -/** Enable or disable location monitoring for geofence monitoring. When enabled, - invokes requestAlwaysAuthorization callback of the LLCallToActionDelegate. - The Delgate should be implemented to prompt for location permissions. - @param enabled YES to enable location monitoring, NO to disable monitoring - - @Attention - SDK5.3 requires LLCallToActionDelegate callback requestAlwaysAuthorization to be implemented - @Version SDK4.3 - */ -+ (void)setLocationMonitoringEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** Enable or disable location monitoring for geofence monitoring. Using this method will - tell Localytics to always look for location permission status, and whenever granted by the end user, - track their location for geofencing purposes. This method will NOT request location permissions. - @param persist YES to allow Localytics to enable location monitoring whenever available, NO to prevent that behavior - - * @Version SDK5.3 - */ -+ (void)persistLocationMonitoring:(BOOL)persist NS_AVAILABLE_IOS(9_0); - -/** Retrieve the closest 20 geofences to monitor based on the devices current location. This method - should be used if you would rather manage location updates and region monitoring instead of - allowing the Localytics SDK to manage location updates and region monitoring automatically when - using persistLocationMonitoring:withForegroundOnlyCapabilities:. This method should be used in conjunction with triggerRegion:withEvent: - and triggerRegions:withEvent:atLocation: to notify the Localytics SDK that regions have been entered or exited. - @param currentCoordinate The devices current location coordinate - @see triggerRegion:withEvent:atLocation: - @see triggerRegions:withEvent:atLocation: - - * @Version SDK4.0 - */ -+ (nonnull NSArray *)geofencesToMonitor:(CLLocationCoordinate2D)currentCoordinate NS_AVAILABLE_IOS(9_0); - -/** Trigger a region with a certain event. This method should be used in conjunction with geofencesToMonitor:. - @param region The CLRegion that is triggered - @param event The triggering event (enter or exit) - @param location A CLLocation that will update the closest geofences for future triggers - @see geofencesToMonitor: - - * @Version SDK5.0 - */ -+ (void)triggerRegion:(nonnull CLRegion *)region withEvent:(LLRegionEvent)event atLocation:(nullable CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** Trigger regions with a certain event at a certain location. This method should be used in - conjunction with geofencesToMonitor:. - @param regions An array of CLRegion object that are triggered - @param event The triggering event (enter or exit) - @param location A CLLocation that will update the closest geofences for future triggers - @see geofencesToMonitor: - * - * @Version SDK5.0 - */ -+ (void)triggerRegions:(nonnull NSArray *)regions withEvent:(LLRegionEvent)event atLocation:(nullable CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Places Push Received. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * - * @Version SDK4.3.0 - */ -+ (void)tagPlacesPushReceived:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * A standard event to tag a Places Push Opened. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * - * @Version SDK4.3.0 - */ -+ (void)tagPlacesPushOpened:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * An event to tag a Places Push Opened with a custom action. - * - * Standard integrations should not require this method. Rather it should only be used - * if standard places triggering is suppressed in favor of custom logic. - * - * @param campaign The Places campaign for which to tag an event - * @param identifier The specific notification action associated with the opened push notification. - * - * @Version SDK4.4.0 - */ -+ (void)tagPlacesPushOpened:(nonnull LLPlacesCampaign *)campaign - withActionIdentifier:(nonnull NSString *)identifier NS_AVAILABLE_IOS(9_0); - -/** - * Trigger a places notification for the given campaign - * - * @param campaign The Places campaign for which to trigger a notification - * - * @Version SDK4.3.0 - */ - -+ (void)triggerPlacesNotificationForCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Trigger a places notification for the given campaign id and regionId - * - * @param campaignId The Places campaign id for which to trigger a notification - * @param regionId The Places region id for which to trigger a notification - * - * @Version SDK4.3.0 - */ - -+ (void)triggerPlacesNotificationForCampaignId:(NSInteger)campaignId - regionIdentifier:(nonnull NSString *)regionId NS_AVAILABLE_IOS(9_0); - - -#pragma mark - In-App Message Delegate -/** --------------------------------------------------------------------------------------- - * @name In-App Message Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set a Messaging delegate - @param delegate An object that implements the LLMessagingDelegate. - @see LLMessagingDelegate - - @Version SDK4.0 - */ -+ (void)setMessagingDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Set a CallToAction delegate - @param delegate An object that implements the LLCallToActionDelegate. - @see LLCallToActionDelegate - - @Version SDK4.0 - */ -+ (void)setCallToActionDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -/** Set whether ADID parameter is added to In-App call to action URLs. By default - the ADID parameter will be added to call to action URLs. - @param enabled Set to YES to enable the ADID parameter or NO to disable it - - * @Version SDK3.4 - */ -+ (void)setInAppAdIdParameterEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - -/** Set whether ADID parameter is added to Inbox call to action URLs. By default - the ADID parameter will be added to call to action URLs. - @param enabled Set to YES to enable the ADID parameter or NO to disable it - - * @Version SDK5.0 - */ -+ (void)setInboxAdIdParameterEnabled:(BOOL)enabled NS_AVAILABLE_IOS(9_0); - - -#pragma mark - Location Delegate -/** --------------------------------------------------------------------------------------- - * @name Location Delegate - * --------------------------------------------------------------------------------------- - */ - -/** Set a Location delegate - @param delegate An object implementing the LLLocationDelegate protocol. - @see LLLocationDelegate - - * @Version SDK4.0 - */ -+ (void)setLocationDelegate:(nullable id)delegate NS_AVAILABLE_IOS(9_0); - -#endif - -@end - -/** - @discussion The class which manages creating, collecting, & uploading a Localytics session. - Please see the following guides for information on how to best use this - library, sample code, and other useful information: - - - Best Practices -
    -
  • Integrate Localytics in applicationDidFinishLaunching.
    • -
  • Open your session and begin your uploads in applicationDidBecomeActive. This way the - upload has time to complete and it all happens before your users have a - chance to begin any data intensive actions of their own.
    • -
  • Close the session in applicationWillResignActive.
    • -
  • Do not call any Localytics functions inside a loop. Instead, calls - such as tagEvent should follow user actions. This limits the - amount of data which is stored and uploaded.
    • -
  • Do not instantiate a Localtyics object, instead use only the exposed class methods.
    • -
- - * @Version SDK3.0 - */ -@interface Localytics : NSObject -@end - -#pragma mark - - -/** - * A protocol used to receive analytics callbacks. - - * @Version SDK3.0 - */ -@protocol LLAnalyticsDelegate -@optional - -/** - * Callback that a session will be opened. Only called when resuming or opening a new session. - * Is not called if a session is currently open. - * - * @param isFirst Boolean indicating that the session will be the first session ever opened - * for this installation. - * @param isUpgrade Boolean indicating that the session will be the first session opened since - * the app was upgraded. - * @param isResume Boolean indicating that an old session will be resumed, as opposed to - * a new session being opened. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionWillOpen:(BOOL)isFirst isUpgrade:(BOOL)isUpgrade isResume:(BOOL)isResume NS_AVAILABLE_IOS(9_0); - -/** - * Callback that a session was either opened or resumed. Is not called if a session was already open. - * - * @param isFirst Boolean indicating that the session is the first session ever opened - * for this installation. - * @param isUpgrade Boolean indicating that the session is the first session opened since - * the app was upgraded. - * @param isResume Boolean indicating that an old session was resumed, as opposed to - * a new session was opened. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionDidOpen:(BOOL)isFirst isUpgrade:(BOOL)isUpgrade isResume:(BOOL)isResume NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an event was tagged. - * - * @param eventName The name of the event. - * @param attributes The event's attributes. - * @param customerValueIncrease The change in a customer's lifetime value associated with this event. - * - * @Version SDK3.0 - */ -- (void)localyticsDidTagEvent:(nonnull NSString *)eventName - attributes:(nullable NSDictionary *)attributes - customerValueIncrease:(nullable NSNumber *)customerValueIncrease NS_AVAILABLE_IOS(9_0); - -/** - * Callback that a session will be closed. Is called only if a session is currently open. Note that - * the session might be resumed if [Localytics openSession] is called, so there is no guarantee that - * the session will actually close after this callback. - * - * @Version SDK3.0 - */ -- (void)localyticsSessionWillClose; - -@end - - -#if !TARGET_OS_TV - -/** - * A protocol used to receive messaging callbacks. - - * @Version SDK3.0.0 - */ -@protocol LLMessagingDelegate -@optional - -/** - * Callback to determine if an In-App campaign should be shown. - * - * @param campaign The campaign that will be shown - * @return The decision to show the In-App campaign. - * - * @Version SDK4.3.0 - */ -- (BOOL)localyticsShouldShowInAppMessage:(nonnull LLInAppCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * 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. - * - * @see [Localytics triggerInAppMessagesForSessionStart] - * - * @return The decision to delay In-App campaigns triggered by the "Session Start" event. - * - * @Version SDK4.3.0 - */ -- (BOOL)localyticsShouldDelaySessionStartInAppMessages NS_AVAILABLE_IOS(9_0); - -/** - * Callback to modify presentation of an In-App Campaign. - * - * @param campaign An immutable object representing the campaign that will be shown - * @param configuration An object representing the mutable visual state of the In-App campaign - * @see LLInAppConfiguration - * @return The modified configuration object containing all preferred display values. - * - * @Version SDK3.0 - */ -- (nonnull LLInAppConfiguration *)localyticsWillDisplayInAppMessage:(nonnull LLInAppCampaign *)campaign withConfiguration:(nonnull LLInAppConfiguration *)configuration NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message was displayed. - * - * @Version SDK3.0 - */ -- (void)localyticsDidDisplayInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message will be dismissed. - * - * @Version SDK3.0 - */ -- (void)localyticsWillDismissInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an In-App message was dismissed. - * - * @Version SDK3.0 - */ -- (void)localyticsDidDismissInAppMessage NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller will be shown. This method is called from the viewWillAppear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsWillDisplayInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller was just shown. This method is called from the viewDidAppear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsDidDisplayInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller will be dismissed. This method is called from the viewWillDisappear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsWillDismissInboxDetailViewController NS_AVAILABLE_IOS(9_0); - -/** - * Callback that an Inbox Detail View Controller was just dismissed. This method is called from the viewDidDisappear: method of UIViewController. - * - * @Version SDK4.4.0 - */ -- (void)localyticsDidDismissInboxDetailViewController NS_AVAILABLE_IOS(9_0); - - -/** - * Callback to determine if the triggering of a Places campaign should show a local notification. - * - * @param campaign An object defining a Places Campaign - * @return The decision to show the local notification. - * - * @Version SDK4.0 - */ -- (BOOL)localyticsShouldDisplayPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Callback to modify the appearance of a local notification. - * - * @param notification The iOS local notification. - * @param campaign The campaign that triggered the Places notification - * @return The iOS notification with all updated preferences - * - * @Version SDK4.0 - */ -- (nonnull UILocalNotification *)localyticsWillDisplayNotification:(nonnull UILocalNotification *)notification forPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_DEPRECATED_IOS(9_0, 10_0); - -/** - * Callback to modify the appearance of a local notification. - * - * @param notification The iOS notification content used to customize a local notification. - * @param campaign The campaign that triggered the Places notification - * @return The iOS notification content with all updated preferences - * - * @Version SDK4.1.0 - */ -- (nonnull UNMutableNotificationContent *)localyticsWillDisplayNotificationContent:(nonnull UNMutableNotificationContent *)notification forPlacesCampaign:(nonnull LLPlacesCampaign *)campaign NS_AVAILABLE_IOS(10_0); - -@end - - -/** - * A protocol used to receive location updates. - * - * @Version SDK4.0 - */ -@protocol LLLocationDelegate -@optional - -/** - * Callback for when a significant location update occurs. - * - * @param location An object representing the updated location. - * - * @Version SDK4.0 - */ -- (void)localyticsDidUpdateLocation:(nonnull CLLocation *)location NS_AVAILABLE_IOS(9_0); - -/** - * Callback for when Localytics updates the regions that are being monitored. - * - * @param addedRegions The list of regions that will be added to monitoring - * @param removedRegions The list of regions which will no longer be monitored. - * - * @Version SDK4.0 - */ -- (void)localyticsDidUpdateMonitoredRegions:(nonnull NSArray *)addedRegions removeRegions:(nonnull NSArray *)removedRegions NS_AVAILABLE_IOS(9_0); - -/** - * Callback for when Localytics recognized the entering or exiting of certain regions - * - * @param regions The list of regions that have been triggered - * @param event An event indicating if the regions were triggered due to entering or exiting. - * - * @Version SDK4.0 - */ -- (void)localyticsDidTriggerRegions:(nonnull NSArray *)regions withEvent:(LLRegionEvent)event NS_AVAILABLE_IOS(9_0); - -@end - -/** - * A protocol used to receive information about Call To Actions triggered by Localytics campaigns. - * - * @Version SDK5.0 - */ -@protocol LLCallToActionDelegate -@optional - -/** - * @param url The URL that was triggered inside a Localytics call to action from any - * messaging (Push, Places, In-App or Inbox) campaign - * @param campaign The campaign that triggered this deeplink (in the case of push, this will be nil). - * @return The decision to allow Localytics to handle the deeplink - */ -- (BOOL)localyticsShouldDeeplink:(nonnull NSURL *)url campaign:(nullable LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * 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. - * - * @param optedOut The result of the call to action indicating that the user opted in (false) or out (true). - * @param campaign The campaign which triggered the opt in/out call. - */ -- (void)localyticsDidOptOut:(BOOL)optedOut campaign:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * 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. - * - * @param privacyOptedOut The result of the call to action indicating that the user opted in (false) or out (true). - * @param campaign The campaign which triggered the privacy opt in/out call. - */ -- (void)localyticsDidPrivacyOptOut:(BOOL)privacyOptedOut campaign:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a location when in use permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the location when in use permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForLocationWhenInUsePermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a location always permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the location always permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForLocationAlwaysPermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); -/** - * Callback to indicate that a user has triggered a notification permission prompt using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - * @param campaign The campaign which triggered the notification permission prompt. - * @return boolean indicating if Localytics should proceed. Returning false will prevent the location prompt. - */ -- (BOOL)localyticsShouldPromptForNotificationPermissions:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); - -/** - * Callback to indicate that a user has triggered a deeplink to the settings using the Javascript - * API provided in a Localytics In-App or Inbox message. - * - @param campaign The campaign which triggered the notification permission prompt. - @return boolean indicating if Localytics should proceed. Returning false will prevent the deeplink to settings. - * - * @Version SDK 5.3 - */ -- (BOOL)localyticsShouldDeeplinkToSettings:(nonnull LLCampaignBase *)campaign NS_AVAILABLE_IOS(9_0); - - -/** - * Callback to request the Always Authorization. Localytics setLocationMonitoringEnabled API requires implementation of this callback. - * @param locationManager CLLocationManager instance to request Authorization - * @discussion Sample Implementation\: [locationManager requestAlwaysAuthorization]; - - @Note Apple requires application developers to be aware and request permissions needed by SDK. - @Version SDK 5.3 - */ -- (void)requestAlwaysAuthorization:(nonnull CLLocationManager *)locationManager NS_AVAILABLE_IOS(9_0); - -/** - * Callback to request When in Use Authorization. - @param locationManager CLLocationManager instance to request Authorization - * - * Sample Implementation \: [locationManager requestWhenInUseAuthorization]; - @Note Apple requires application developers to be aware and request permissions needed by SDK. - @Version SDK 5.3 - */ -- (void)requestWhenInUseAuthorization:(nonnull CLLocationManager *)locationManager NS_AVAILABLE_IOS(9_0); -@end -#endif - diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LocalyticsTypes.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LocalyticsTypes.h deleted file mode 100644 index 6c4255c..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Headers/LocalyticsTypes.h +++ /dev/null @@ -1,93 +0,0 @@ -// -// LocalyticsTypes.h -// Copyright (C) 2017 Char Software Inc., DBA Localytics -// -// This code is provided under the Localytics Modified BSD License. -// A copy of this license has been distributed in a file called LICENSE -// with this source code. -// -// Please visit www.localytics.com for more information. -// - - -/** An enum to define the location that the In-App dismiss button should be shown. */ -typedef NS_ENUM(NSUInteger, LLInAppMessageDismissButtonLocation){ - /** A value to specify rendering of the In-App dismiss button on the left. */ - LLInAppMessageDismissButtonLocationLeft, - /** A value to specify rendering of the In-App dismiss button on the right. */ - LLInAppMessageDismissButtonLocationRight -}; - -/** An enum to define the event type that triggered a geofence. */ -typedef NS_ENUM(NSInteger, LLRegionEvent){ - /** A value to specify that the geofence boundary was crossed as an entrance into the geofence */ - LLRegionEventEnter, - /** A value to specify that the geofence boundary was crossed as an exit out the geofence */ - LLRegionEventExit -}; - -/** An enum to define the scope a profile attribute should be associated with. */ -typedef NS_ENUM(NSInteger, LLProfileScope){ - /** A value to specify that the profile attribute is scoped to this specific application and doesn't apply in other applications */ - LLProfileScopeApplication, - /** A value to specify that the profile attribute is scoped to the organization and applies across all apps */ - LLProfileScopeOrganization -}; - -/** An enum to define the type of In-App. */ -typedef NS_ENUM(NSInteger, LLInAppMessageType) { - /** A value to specify that the In-App is a top banner campaign. */ - LLInAppMessageTypeTop, - /** A value to specify that the In-App is a bottom banner campaign. */ - LLInAppMessageTypeBottom, - /** A value to specify that the In-App is a center campaign. */ - LLInAppMessageTypeCenter, - /** A value to specify that the In-App is a full screen campaign. */ - LLInAppMessageTypeFull -}; - -/** An enum to specify the default conversion type of an In-App. */ -typedef NS_ENUM(NSInteger, LLImpressionType) { - /** A value to specify the default value of click, which will be counted as a conversion */ - LLImpressionTypeClick, - /** A value to specify the default value of dismiss, which will not be counted as a conversion */ - LLImpressionTypeDismiss -}; - -// For iOS 13.x and below compatibility, numbers match to ATTrackingManagerAuthorizationStatus enum -typedef NS_ENUM(NSInteger, LLAdIdStatus) { - LL_IDFA_NOT_DETERMINED = 0, - LL_IDFA_RESTRICTED = 1, - LL_IDFA_DENIED = 2, - LL_IDFA_AUTHORIZED = 3, - LL_IDFA_NOT_REQUIRED = 4 -}; - -/** - Represents the interval at which the Localytics SDK will upload data in the case of a WiFi - connection. Having a WiFi connection will supersede any mobile data connection. Default value - is 5 seconds. To disable uploading for this connectivity set the value to -1 - */ -#define LOCALYTICS_WIFI_UPLOAD_INTERVAL_SECONDS @"ll_wifi_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 4G - or LTE connections. Default value is 10 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_GREAT_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_great_network_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 3G - connection. Default value is 30 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_DECENT_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_decent_network_upload_interval_seconds" - -/** - Represents the interval at which the Localytics SDK will upload data in the case of 2G - or EDGE connections. Default value is 90 seconds. To disable uploading for this connectivity - set the value to -1 - */ -#define LOCALYTICS_BAD_NETWORK_UPLOAD_INTERVAL_SECONDS @"ll_bad_network_upload_interval_seconds" - diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Info.plist b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Info.plist deleted file mode 100644 index 38a769e..0000000 Binary files a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Info.plist and /dev/null differ diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Localytics b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Localytics deleted file mode 100755 index a666f9d..0000000 Binary files a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Localytics and /dev/null differ diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Modules/module.modulemap b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Modules/module.modulemap deleted file mode 100644 index c8f9fed..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module Localytics { - umbrella header "Localytics-Framework.h" - - export * - module * { export * } -} diff --git a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h b/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h deleted file mode 100644 index dfa6e1a..0000000 --- a/Localytics-iOS-Latest/Localytics.xcframework/ios-arm64_i386_x86_64-simulator/Localytics.framework/PrivateHeaders/LLPushToInboxCampaignJson.h +++ /dev/null @@ -1,24 +0,0 @@ -#import - -@class LLApsDictionary; -@class LLMarketingLogger; -@protocol LLLocalyticsDelegate; - -@interface LLPushToInboxCampaignJson : NSObject - -@property (nonatomic, copy, readonly, nonnull) NSDictionary *attributes; -@property (nonatomic, copy, readonly, nonnull) NSDictionary *markerDictionary; - -- (nonnull NSDictionary *)generateLoggingDictionary; - -+ (nullable instancetype)withPayload:(nonnull NSDictionary *)payload - apsDictionary:(nonnull LLApsDictionary *)apsDictionary - logger:(nonnull LLMarketingLogger *)logger - localyticsDelegate:(nonnull id)localyticsDelegate; - -- (nullable instancetype)initWithPayload:(nonnull NSDictionary *)payload - apsDictionary:(nonnull LLApsDictionary *)apsDictionary - logger:(nonnull LLMarketingLogger *)logger - localyticsDelegate:(nonnull id)localyticsDelegate; - -@end diff --git a/Localytics-iOS-Latest/iOSa_6.2.9.version b/Localytics-iOS-Latest/iOSa_6.3.0.version similarity index 100% rename from Localytics-iOS-Latest/iOSa_6.2.9.version rename to Localytics-iOS-Latest/iOSa_6.3.0.version diff --git a/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.3.7.aar b/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.3.7.aar deleted file mode 100644 index 68caa70..0000000 Binary files a/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.3.7.aar and /dev/null differ diff --git a/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.4.0.aar b/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.4.0.aar new file mode 100644 index 0000000..5029833 Binary files /dev/null and b/LocalyticsXamarin/LocalyticsXamarin.Android/Jars/library-6.4.0.aar differ diff --git a/LocalyticsXamarin/LocalyticsXamarin.Android/LocalyticsXamarin.Android.csproj b/LocalyticsXamarin/LocalyticsXamarin.Android/LocalyticsXamarin.Android.csproj index 5d99b39..c739ff4 100644 --- a/LocalyticsXamarin/LocalyticsXamarin.Android/LocalyticsXamarin.Android.csproj +++ b/LocalyticsXamarin/LocalyticsXamarin.Android/LocalyticsXamarin.Android.csproj @@ -442,7 +442,7 @@ - + diff --git a/LocalyticsXamarin/LocalyticsXamarin.Android/Properties/AssemblyInfo.cs b/LocalyticsXamarin/LocalyticsXamarin.Android/Properties/AssemblyInfo.cs index b77dada..2b11f47 100644 --- a/LocalyticsXamarin/LocalyticsXamarin.Android/Properties/AssemblyInfo.cs +++ b/LocalyticsXamarin/LocalyticsXamarin.Android/Properties/AssemblyInfo.cs @@ -17,7 +17,7 @@ // The form "{Major}.{Minor}.*" will automatically update the build and revision, // and "{Major}.{Minor}.{Build}.*" will update just the revision. -[assembly: AssemblyVersion("66.3.1.*")] +[assembly: AssemblyVersion("66.3.2.*")] // The following attributes are used to specify the signing key for the assembly, // if desired. See the Mono documentation for more information about signing. diff --git a/LocalyticsXamarin/LocalyticsXamarin.Common/Properties/AssemblyInfo.cs b/LocalyticsXamarin/LocalyticsXamarin.Common/Properties/AssemblyInfo.cs index 65a3bf0..4df119d 100644 --- a/LocalyticsXamarin/LocalyticsXamarin.Common/Properties/AssemblyInfo.cs +++ b/LocalyticsXamarin/LocalyticsXamarin.Common/Properties/AssemblyInfo.cs @@ -20,7 +20,7 @@ // The form "{Major}.{Minor}.*" will automatically update the build and revision, // and "{Major}.{Minor}.{Build}.*" will update just the revision. -//[assembly: AssemblyVersion ("6.3.1.*")] +//[assembly: AssemblyVersion ("6.3.2.*")] // The following attributes are used to specify the signing key for the assembly, diff --git a/LocalyticsXamarin/LocalyticsXamarin.NuGet/Localytics.NuGet.nuproj b/LocalyticsXamarin/LocalyticsXamarin.NuGet/Localytics.NuGet.nuproj index 8293f6a..cf0231f 100644 --- a/LocalyticsXamarin/LocalyticsXamarin.NuGet/Localytics.NuGet.nuproj +++ b/LocalyticsXamarin/LocalyticsXamarin.NuGet/Localytics.NuGet.nuproj @@ -7,7 +7,7 @@ {3D21B247-4672-466E-9F96-616FC955F033} Localytics Xamarin SDK for Android and iOS LocalyticsXamarin - 6.3.1 + 6.3.2 Localytics false false diff --git a/LocalyticsXamarin/LocalyticsXamarin.iOS/Properties/AssemblyInfo.cs b/LocalyticsXamarin/LocalyticsXamarin.iOS/Properties/AssemblyInfo.cs index f2cebf6..11e5c6b 100644 --- a/LocalyticsXamarin/LocalyticsXamarin.iOS/Properties/AssemblyInfo.cs +++ b/LocalyticsXamarin/LocalyticsXamarin.iOS/Properties/AssemblyInfo.cs @@ -26,7 +26,7 @@ // The form "{Major}.{Minor}.*" will automatically update the build and revision, // and "{Major}.{Minor}.{Build}.*" will update just the revision. -//[assembly: AssemblyVersion ("6.3.1.*")] +//[assembly: AssemblyVersion ("6.3.2.*")] // The following attributes are used to specify the signing key for the assembly, // if desired. See the Mono documentation for more information about signing. diff --git a/LocalyticsXamarin/iOS/LocalyticsSample.iOS.csproj b/LocalyticsXamarin/iOS/LocalyticsSample.iOS.csproj index 8dbcc20..05b50fe 100644 --- a/LocalyticsXamarin/iOS/LocalyticsSample.iOS.csproj +++ b/LocalyticsXamarin/iOS/LocalyticsSample.iOS.csproj @@ -23,7 +23,7 @@ prompt 4 false - i386, x86_64 + x86_64 None true iPhone Developer diff --git a/Makefile b/Makefile index fc49557..5e6cd28 100644 --- a/Makefile +++ b/Makefile @@ -31,7 +31,7 @@ ifneq ($(VER),) @rm LocalyticsXamarin/LocalyticsXamarin.iOS/Properties/AssemblyInfo.cs.org LocalyticsXamarin/LocalyticsXamarin.Android/Properties/AssemblyInfo.cs.org LocalyticsXamarin/LocalyticsXamarin.Common/Properties/AssemblyInfo.cs.org LocalyticsXamarin/LocalyticsXamarin.NuGet/Localytics.NuGet.nuproj.org #Build all projects and validate @cd LocalyticsXamarin/LocalyticsXamarin.Android && msbuild /t:Rebuild /p:Configuration=Release - @cd LocalyticsXamarin/iOS && msbuild /t:Rebuild /p:Configuration=Release + @cd LocalyticsXamarin/iOS && msbuild /t:Rebuild /p:Configuration=Release /p:MtouchArch=x86_64 #Build NUget Package @cd LocalyticsXamarin/LocalyticsXamarin.NuGet && dotnet restore && msbuild /t:Rebuild /p:Configuration=Release @echo Publish LocalyticsXamarin/LocalyticsXamarin.NuGet/bin/Release/LocalyticsXamarin.$(VER).nupkg