iOS SDK

Added

• Adds improved support for in-app message display on iPhone 12 models.

Added

• Adds initial support for Swift Package Manager. There are 2 new packages that have been added: AppboyKit for the core SDK and AppboyUI for the full SDK (including UI elements), which correspond to the Appboy-iOS-SDK/Core and Appboy-iOS-SDK pods, respectively.
  • Note that tvOS support is not available via Swift Package Manager for this release. Push Stories is only available through a side-by-side integration with Cocoapods.
  • To add the package to your project follow these steps:
    • Select File > Swift Packages > Add Package Dependency.
      • In the search bar, enter https://github.com/Appboy/Appboy-ios-sdk.
      • Select one of AppboyKit or AppboyUI. Note that AppboyUI includes AppboyKit automatically.
    • In your app's target, under Build Settings > Other Linker Flags, add the -ObjC linker flag.
    • In the Xcode menu, click Product > Scheme > Edit Scheme...
      • Click the expand ▶️ next to Build and select Post-actions. Press + and select New Run Script Action.
      • In the dropdown next to Provide build settings from, select your app's target.
      • Copy this script into the open field:

        rm -rf "${TARGET_BUILD_DIR}/${PRODUCT_NAME}.app/Frameworks/libAppboyKitLibrary.a"
        rm -rf "${TARGET_BUILD_DIR}/${PRODUCT_NAME}.app/Plugins/libAppboyKitLibrary.a"
        

Breaking

• Removes userNotificationWasSentFromAppboy: and pushNotificationWasSentFromAppboy: on Appboy. Use isAppboyUserNotification: and isAppboyRemoteNotification: in ABKPushUtils instead.
• Updates ABKURLDelegate's method signature for handleAppboyURL:fromChannel:withExtras: to include nullability annotations required for proper Swift support.

Fixed

• Fixes a race condition in Appboy method wipeDataAndDisableForAppRun where certain persisted fields would still be available immediately after calling the method. These fields now are removed synchronously.

Changed

• Updated SDWebImage to use version 5.9.x.

Breaking

• Adds support for iOS 14. Requires Xcode 12.
• Removes the ABK_ENABLE_IDFA_COLLECTION preprocessor macro from the SDK.
  • If you wish to send IDFA to Braze, please use the ABKIDFADelegate. For more information, reference our documentation.
• Updates the ABKIDFADelegate protocol by renaming isAdvertisingTrackingEnabled to isAdvertisingTrackingEnabledOrATTAuthorized to reflect the addition of the AppTrackingTransparency framework in iOS 14.
  • If you use the Ad Tracking Enabled segment filter on the Braze dashboard or are implementing AppTrackingTransparency, you must update your integration to use AppTrackingTransparency to read the correct user status. Please see our sample app for implementation details.
  • If you do not use the Ad Tracking Enabled segment filter and are not implementing AppTrackingTransparency yet, your implementation of isAdvertisingTrackingEnabledOrATTAuthorized may temporarily continue to use isAdvertisingTrackingEnabled. However, the returned value will always be NO in iOS 14, regardless of actual IDFA availability.
  • Note that Apple announced that they will delay the enforcement of upcoming IDFA changes until early 2021. Please reference our iOS 14 upgrade guide for more details.
• Updates the minimum required version of SDWebImage from 5.0 to 5.8.2.
• Integrators will now be required to exclude the arm64 simulator slice in their entire project.
  • This is done automatically when integrating via Cocoapods.
  • For other cases:
    • If you are using xcconfig files to build your app, please set:
      • For iOS targets: EXCLUDED_ARCHS[sdk=iphonesimulator*] = arm64
      • For tvOS targets: EXCLUDED_ARCHS[sdk=appletvsimulator*] = arm64
    • If you are using the Xcode Build Settings panel, enable Build Active Architecture Only for the configuration you use to run your app on the simulator. (ONLY_ACTIVE_ARCH = YES)

• This release can be used to beta test iOS 14. See 3.27.0-beta2 and 3.27.0-beta1 notes for additional changes.

Changed

• Adds support for Push Stories and the tvOS SDK when using Xcode 12.

• This release can be used to beta test iOS 14. See 3.27.0-beta1 notes for additional changes.
• Push Stories and the tvOS SDK are not yet compatible with Xcode 12. This will be added in a future beta release.

Breaking

• Updates IDFADelegate protocol by renaming isAdvertisingTrackingEnabled to isAdvertisingTrackingEnabledOrATTAuthorized to reflect the new requirements of iOS 14. See the IDFADelegate implementation in Stopwatch for an example.

Changed

• Integrators will now be required to exclude the arm64 simulator slice in their entire project.
  • This is done automatically when integrating via Cocoapods.
  • For other cases:
    • If you are using xcconfig files to build your app, please set:
      • For iOS targets: EXCLUDED_ARCHS[sdk=iphonesimulator*] = arm64
      • For tvOS targets: EXCLUDED_ARCHS[sdk=appletvsimulator*] = arm64
    • If you are using the Xcode Build Settings panel, enable Build Active Architecture Only for the configuration you use to run your app on the simulator. (ONLY_ACTIVE_ARCH = YES)

Changed

• Deprecates the compilation macro ABK_ENABLE_IDFA_COLLECTION in favor of the ABKIDFADelegate implementation.
  • ABK_ENABLE_IDFA_COLLECTION will not function properly in iOS 14. To continue collecting IDFA on iOS 14 devices, please upgrade to Xcode 12 and implement App Tracking Transparency and Braze's ABKIDFADelegate (see the iOS 14 upgrade guide for more information).

Added

• Adds improved support for iOS 14 Approximate Location tracking.

• This release can be used to beta test iOS 14.
• Push Stories and the tvOS SDK are not yet compatible with Xcode 12. This will be added in a future beta release.

Breaking

• Requires Xcode 12.
• Updates the minimum required version of SDWebImage from 5.0 to 5.8.2.
• Removes the ABK_ENABLE_IDFA_COLLECTION preprocessor macro from the SDK.
  • If you wish to enable IDFA, please use the ABKIDFADelegate.
  • Integration instructions for supporting iOS 14 in your ABKIDFADelegate will be included in a future beta release.

Updated

• Adds support for iOS 14's Approximate Location feature.
  • Note that the Geofence feature will not work if the end user chooses to provide only approximate location.
  • Optional session-start based location tracking will continue to work. Accuracy will be based on the user's precise vs. approximate choice.

Breaking

• Removed readonly property overrideApplicationStatusBarHiddenState in ABKInAppMessageViewController.h.

Fixed

• Fixes an issue with in-app messages not respecting the application's status bar style when View controller-based status bar appearance (UIViewControllerBasedStatusBarAppearance) is set to YES in the Info.plist.
• Fixes an issue which can lead to text being cut off in Content Cards for specific iPhone models.
• Fixes an issue preventing test Content Cards from displaying under specific conditions.

Changed

• Added Binary Project Specification file for more efficient Carthage integration of the full SDK.
  • Update your Cartfile to use binary "https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/appboy_ios_sdk_full.json"
  • Support for this integration method was added starting with version 3.24.0 of the SDK.

Added

• Adds support for specifying PushStoryAppGroup in the Appboy dictionary in your app's Info.plist. This Apple App Group will share the Braze Push Story information such as Campaign IDs between applications from a single Apple Developer account.
• Adds appboyBridge.getUser().addAlias(alias, label) to the javascript interface for HTML in-app messages.
• Adds the property overrideUserInterfaceStyle to ABKInAppMessage that allows forcing Light or Dark mode in the same way as Apple's UIViewController.overrideUserInterfaceStyle.
  • You can set this property in the beforeInAppMessageDisplayed: method of an ABKInAppMessageControllerDelegate.
• Adds the ability to dismiss modal in-app messages when the user clicks outside of the in-app message.
  • This feature is disabled by default.
  • You can enable the feature by adding the Appboy dictionary to your Info.plist file. Inside the Appboy dictionary, add the DismissModalOnOutsideTap boolean subentry and set the value to YES.
  • You can also enable the feature at runtime by setting ABKEnableDismissModalOnOutsideTapKey to YES in appboyOptions.

3.25.0

Breaking

• Removes the arm64e architecture when building with Cocoapods.
• Removes the deprecated property appWindow from ABKInAppMessageWindowController.

3.24.2

Fixed

• Fixes an issue with post-dismissal view hierarchy restoration for in-app messages under specific conditions.

Changed

• Deprecates ABKInAppMessageWindowController property appWindow.

3.24.1

Fixed

• Fixes an issue introduced in 3.24.0 breaking the SDK compatibility with Cocoapods.

Important This release is not compatible with Cocoapods. Do not upgrade to this version and upgrade to 3.24.1 and above instead.

Breaking

• Renames ABKInAppMessageWindow's catchClicksOutsideInAppMessage to handleAllTouchEvents.

Fixed

• Fixes an issue where the unread indicator on a Content Card would persist even after being read.
• Fixes an issue preventing long texts from displaying correctly in Full in-app messages.

Added

• Adds support for JavaScript functions window.alert(), window.confirm() and window.prompt() in HTML in-app messages.
• Adds the ABKContentCardsTableViewControllerDelegate protocol to more intricately handle Content Card clicks using the methods contentCardTableViewController:shouldHandleCardClick: and contentCardTableViewController:didHandleCardClick:.

Fixed

• Fixes an issue with regex based event property triggers not working as expected. Previously on iOS they had to match the entire string, now they will search for matches as expected.
• Improves resiliency when handling multiple background requests.

Added

• Adds support for upcoming HTML In-App Message templates.
• Adds support for applications using scenes (UIWindowSceneDelegate). In-app messages are now properly displayed in that context.

Breaking

• Removes the key ABKInAppMessageHideStatusBarKey from appboyOptions and the property forceHideStatusBar from ABKInAppMessageController. Full screen in-app messages are now always displayed with the status bar hidden.
• Adds Dark Mode support to Content Cards. This feature is enabled by default and can be disabled by setting enableDarkTheme property to NO on ABKContentCardsTableViewController before the view controller is presented.

Fixed

• Fixes an issue in HTML in-app messages where button clicks weren't correctly being attributed for mailto: and tel: links.
• Fixes an issue in HTML in-app messages where videos would be displayed underneath the in-app message when full screen playback was enabled. The in-app message UIWindow's windowLevel is now set to UIWindowLevelNormal instead of being above UIWindowLevelStatusBar.
• Fixes an issue in Content Cards where ABKURLDelegate was not being respected when opening links.

Added

• Adds appboyBridge.logClick(id), appboyBridge.logClick() and appboyBridge.getUser().setCustomLocationAttribute(key, latitude, longitude) to the javascript interface for HTML in-app messages.
• Adds Czech and Ukrainian language support for Braze UI elements.
• Adds the ability to unset the current user's email attribute by setting the email property of the current ABKUser instance to nil (e.g. [Appboy sharedInstance].user.email = nil;).
• Adds Dark Mode support to Push Stories.
• Adds the ability to set maximum width of Content Cards by using the maxContentCardWidth property of ABKContentCardsTableViewController.

Added

• Adds an option to disable automatic geofence requests.
  • You can do this in the plist by adding the Appboy dictionary to your Info.plist file. Inside the Appboy dictionary, add the DisableAutomaticGeofenceRequests boolean subentry and set the value to YES.
  • You can also disable automatic geofence requests at runtime by setting ABKDisableAutomaticGeofenceRequestsKey to YES in appboyOptions.
• Adds the method requestGeofencesWithLongitude:latitude: to Appboy.h. This method can be called whenever you explicitly want Braze to send a request for updated Geofences information. This call is rate limited to once per user session.

Fixed

• Fixes an issue in HTML in-app messages where, during display, the viewport would shift down if the keyboard was opened but not shift back up when the keyboard was closed.
• Fixes an issue introduced in 3.17.0 where the SDK would give precedence to the endpoint passed in Info.plist if given both an endpoint from the Info.plist and appboyOptions.

Added

• Adds the ability to set a custom WKWebViewConfiguration for HTML in-app messages. You can set it using the method setCustomWKWebViewConfiguration in ABKInAppMessageUIDelegate.

Changed

• Removes calls to deprecated APIs statusBarOrientation and statusBarFrame.
• Un-deprecates the following push utility methods: isUninstallTrackingUserNotification:, isUninstallTrackingRemoteNotification:, isGeofencesSyncUserNotification:, isGeofencesSyncRemoteNotification:, and isPushStoryRemoteNotification: from ABKPushUtils. These APIs were originally deprecated in 3.16.0.

Fixed

• Fixes an issue for Modal and Full in-app messages where the opacity value of the close X button was not being respected.

Changed

• ABKContentCard.m will now log a click event when logContentCardClicked is called and no URL field is populated.

Added

• Adds the ability to force the status bar to hide when a Full or HTML in-app message is being actively displayed. To opt in to this feature, set ABKInAppMessageHideStatusBarKey to YES in appboyOptions.

Fixed

• Fixes an issue in the animate-in behavior of HTML in-app messages that could cause a brief flicker before the message displayed on older devices and simulators.
• Fixes an issue with Slideup in-app messages where they would cover part of the status bar when animating from the top on non-notched devices.
• Fixes an issue introduced in 3.14.1 where boolean-typed event properties would be improperly cast to numbers.

Changed

• Updates the logging format for debug, warn, and error ABKLogger messages to now print their log level.

Added

• Adds support for the upcoming feature, in-app messages with Dark Mode support.
  • Dark Mode enabled messages must be created from the dashboard. Braze does not dynamically theme in-app messages for Dark Mode.
  • This feature is enabled by default for all new ABKInAppMessage instances. To prevent Braze from automatically applying a Dark Theme when the fields are available on Braze's servers, set the enableDarkTheme flag on ABKInAppMessage to NO in the beforeInAppMessageDisplayed: method of your ABKInAppMessageControllerDelegate delegate implementation.
• Adds the ability to reference the Braze iOS SDK API from Swift when using the Appboy-tvOS-SDK pod. Adding import AppboyTVOSKit to the top of your Swift file while using the Appboy-tvOS-SDK pod will give you equivalent behavior to adding import Appboy_iOS_SDK while using the Appboy-iOS-SDK pod.
• Adds the populateContentCards: method and the cards property to ABKContentCardsTableViewController's public interface. By setting the cards property from within populateContentCards:, you may manipulate ABKContentCard field data and/or control which ABKContentCard instances are displayed from the context of a custom ABKContentCardsTableViewController subclass.

Fixed

• Fixed an issue with Content Cards where the header and description text fields would appear to be missing in Dark Mode.

Added

• Adds a TEALIUM SDK flavor option.

Note

• This SDK release contains a framework build that is backwards compatible with iOS 8. Please see the binaries section of this page.

Added

• After any affirmative location permission prompt, the SDK now submits a session start location request if location hasn't already been sent up for the session. This also applies to the new "Allow Once" option in iOS 13.

Important If you are on Braze iOS SDK 3.19.0 or below, we recommend upgrading to this version immediately to ensure uninterrupted collection of new push tokens as users upgrade to iOS 13.

• In application:didRegisterForRemoteNotificationsWithDeviceToken:, replace

[[Appboy sharedInstance] registerPushToken:
                [NSString stringWithFormat:@"%@", deviceToken]];

with

[[Appboy sharedInstance] registerDeviceToken:deviceToken];

• If you are on Braze iOS SDK 3.19.0 or below and unable to upgrade, you must ensure your [Appboy registerPushToken] implementation does not rely on stringWithFormat or description for parsing the deviceToken passed in from application:didRegisterForRemoteNotificationsWithDeviceToken:. Please reach out to your Customer Success Manager for more information.

• Important In Braze iOS SDK 3.19.0, we updated our HTML in-app message container from UIWebview to WKWebView, however, the initial releases have known issues displaying HTML in-app messages. If you are currently using 3.19.0, 3.20.0, or 3.20.1, you are strongly encouraged to upgrade if you make use of HTML in-app messages. Please see the following for more important information about the transition to WKWebView:

  • If you are utilizing customization for HTML in-app messages (such as customizing ABKInAppMessageHTMLFullViewController or ABKInAppMessageHTMLViewController), we strongly recommend testing to ensure your in-app messages continue to display correctly and interactions function as intended.
  • The following javascript methods are now no-ops: alert, confirm, prompt.
  • Deep links without schemes are no longer supported. Ensure that your in-app message deep links contain schemes.

Fixed

• Fixes an issue introduced in 3.19.0 where HTML in-app messages would not register user clicks when the .xib failed to load.
• Fixes an issue introduced in 3.19.0 where HTML in-app messages with select special characters and an assets zip would cause display irregularities.

Changed

• Updates the WKWebView which displays HTML in-app messages with the following attributes:
  • suppressesIncrementalRendering is set to true
  • mediaTypesRequiringUserActionForPlayback is set to WKAudiovisualMediaTypeAll
• Updates the background color of the WKWebView which displays HTML in-app messages from [[UIColor blackColor] colorWithAlphaComponent:.3] to [UIColor clearColor].

Important This release has known issues displaying HTML in-app messages. Do not upgrade to this version and upgrade to 3.20.2 and above instead. If you are using this version, you are strongly encouraged to upgrade to 3.20.2 or above if you make use of HTML in-app messages.

Fixed

• Fixes an issue introduced in 3.19.0 which changed the background of HTML in-app messages to a non-transparent color.
• Improves the robustness of push token collection code for iOS 13 introduced in 3.20.0.

Important This release has known issues displaying HTML in-app messages and a known issue with push token collection. Do not upgrade to this version and upgrade to 3.20.2 and above instead. If you are using this version, you are strongly encouraged to upgrade to 3.20.2 or above if you make use of HTML in-app messages.

Breaking

• Introduced a signature change for push token collection methods:

[[Appboy sharedInstance] registerPushToken:
                [NSString stringWithFormat:@"%@", deviceToken]];

with

[[Appboy sharedInstance] registerDeviceToken:deviceToken];

Important This release has known issues displaying HTML in-app messages. Do not upgrade to this version and upgrade to 3.20.2 and above instead. If you are using this version, you are strongly encouraged to upgrade to 3.20.2 or above if you make use of HTML in-app messages.

Breaking

• Replaces UIWebView with WKWebView for HTML in-app messages.
  • If you are utilizing customization for HTML in-app messages (such as customizing ABKInAppMessageHTMLFullViewController or ABKInAppMessageHTMLViewController), you must test to ensure your in-app messages continue to display correctly and interactions function as intended.
  • The following javascript methods are now no-ops: alert, confirm, prompt.
  • Deep links without schemes are no longer supported. Please ensure that your in-app message deep links contain schemes.

Breaking

• Automatic Braze location collection is now disabled by default. If you choose to use our location collection, you must explicitly enable location collection.
  • You can do this in the plist by adding the Appboy dictionary to your Info.plist file. Inside the Appboy dictionary, add the EnableAutomaticLocationCollection boolean subentry and set the value to YES.
  • You can also enable location at runtime by setting ABKEnableAutomaticLocationCollectionKey to YES in appboyOptions.
• Removes the Feedback feature from the SDK. The Feedback subspec and all Feedback methods on the SDK, including [[Appboy sharedInstance] submitFeedback] and [[Appboy sharedInstance] logFeedbackDisplayed], are removed.

Changed

• Improves support for in-app messages on “notched” devices (for example, iPhone X, Pixel 3XL). Full-screen messages now expand to fill the entire screen of any phone, while covering the status bar.

Added

• Adds the ability to enable Braze Geofences without enabling Braze location collection. You can set this in the plist by adding the Appboy dictionary to your Info.plist file. Inside the Appboy dictionary, add the EnableGeofences boolean subentry and set the value to YES to enable Braze Geofences. You can also enable geofences at runtime by setting ABKEnableGeofencesKey to YES in appboyOptions.
  • If this key is not set, it will default to the status of automatic location collection (see breaking change above).
  • Note that Braze Geofences will continue to work on existing integrations if location collection is enabled and this new configuration is not present. This new configuration is intended for integrations that want Braze Geofences, but not location collection enabled as well.

Breaking

• Removes ABKAppboyEndpointDelegate.
  • You can now set the endpoint at runtime by setting the value of ABKEndpointKey in appboyOptions to your custom endpoint (ex. sdk.api.braze.eu) at initialization.

Breaking

• Removes the methods: allowRequestWhenInUseLocationPermission and allowRequestAlwaysPermission from ABKLocationManager.
  • To request when in use location permission, use the following code:

  CLLocationManager *locationManager = [[CLLocationManager alloc] init];
  [locationManager requestWhenInUseAuthorization];
  

  • To request always location permission, use the following code:

  CLLocationManager *locationManager = [[CLLocationManager alloc] init];
  [locationManager requestAlwaysAuthorization];
  

  • The preprocessor macro ABK_DISABLE_LOCATION_SERVICES is no longer needed.
  • Important: Configuring geofences to request always location permissions remotely from the Braze dashboard is no longer supported. If you are using Geofences, you will need to ensure that your app requests always location permission from your users manually.
• ABKAutomaticRequestProcessingExceptForDataFlush is deprecated. Users using ABKAutomaticRequestProcessingExceptForDataFlush should switch to ABKManualRequestProcessing, as the new behavior of ABKManualRequestProcessing is identical to the previous behavior of ABKAutomaticRequestProcessingExceptForDataFlush

Changed

• Deprecates the push utility methods: isUninstallTrackingUserNotification:, isUninstallTrackingRemoteNotification:, isGeofencesSyncUserNotification:, isGeofencesSyncRemoteNotification:, and isPushStoryRemoteNotification: from ABKPushUtils. Please use the function isAppboyInternalRemoteNotification:.
• Minor changes to the logic of ABKManualRequestProcessing. The original ABKManualRequestProcessing had specific exceptions and behaved more like ABKAutomaticRequestProcessingExceptForDataFlush in practice. As a result, the two policies have been merged into ABKManualRequestProcessing. Note that the new definition of ABKManualRequestProcessing is that periodic automatic data flushes are disabled. Other requests important to basic Braze functionality will still occur.

Breaking

• Adds support for SDWebImage version 5.0.
  • Note that upgrading to SDWebImage 5.0 also removed the FLAnimatedImage transitive dependency from the SDK.

Changed

• Changed in-app message trigger behavior to not perform trigger events until after any pending trigger sync requests to the server have finished.

Fixed

• Fixed a serialization issue that could cause improper type conversions for certain decimal values.
• Fixed a behavior introduced in 3.12.0 which caused in-app messages to not be considered triggered locally if ABKDiscardInAppMessage was returned by the host app in beforeInAppMessageDisplayed:.

Added

• Added the ability to set the session timeout via the Info.plist.
  • Add the Appboy dictionary to your Info.plist file. Inside the Appboy Dictionary, add the SessionTimeout Number subentry and set the value to your session timeout.
• Added the ability to disable location tracking via the Info.plist.
  • Add the Appboy dictionary to your Info.plist file. Inside the Appboy Dictionary, add the DisableAutomaticLocation Boolean subentry and set the value to YES.
• Added dynamic cell resizing for Content Cards cells with templated images in our default Content Cards UI.
• Added validation to the local filename's canonical path during zip file extraction.