Releases: braze-inc/braze-unity-sdk
Releases · braze-inc/braze-unity-sdk
6.0.0
Breaking
- Updated the native iOS bridge from Braze Swift SDK 7.7.0 to 9.0.0.
- Updated the native Android bridge from Braze Android SDK 29.0.1 to 30.3.0.
Added
- Added iOS In App Message Manager Initial Display Operation configuration setting.
- This setting allows you to configure the initial display operation for in-app messages on iOS. For instance, set it to Display Later to delay the initial display of in-app messages until after your game has finished loading, and use the
AppboyBinding.DisplayNextInAppMessage()
method to display it when ready.
- This setting allows you to configure the initial display operation for in-app messages on iOS. For instance, set it to Display Later to delay the initial display of in-app messages until after your game has finished loading, and use the
- Added the Entitlements File Path configuration setting.
- This setting allows you to specify the path to an entitlements file to be used / modified by Braze in the Xcode project.
- If left blank, the default entitlements file will be used / created.
5.2.1
5.2.0
Added
- Updated the native iOS bridge from Braze Swift SDK 7.4.0 to 7.7.0.
- Updated the version of
SDWebImage
from 5.15.5 to 5.19.0 when automatically importing via "Braze Configuration".- This version of
SDWebImage
contains a Privacy Manifest file. See Apple's documentation for more information.
- This version of
5.1.0
Added
- Added support for custom user attributes to be nested objects.
AppboyBinding.SetCustomUserAttribute(string, Dictionary<string, object>);
AppboyBinding.SetCustomUserAttribute(string, List<Dictionary<string, object>>);
- You can specify that the Dictionary be merged with the existing value.
AppboyBinding.SetCustomUserAttribute(string, Dictionary<string, object>, bool merge);
- See https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/nested_custom_attribute_support/ for more information.
- Added
AppboyBinding.LogFeatureFlagImpression(string id)
to log a Feature Flag impression.
5.0.0
Breaking
- Updated the native iOS bridge from Braze Swift SDK 6.1.0 to 7.4.0.
- The iOS repository link now points to the prebuilt dynamic XCFrameworks from this repo:
https://github.com/braze-inc/braze-swift-sdk-prebuilt-dynamic
.
- The iOS repository link now points to the prebuilt dynamic XCFrameworks from this repo:
- Updated the native Android bridge from Braze Android SDK 27.0.1 to 29.0.1.
AppboyBinding.GetFeatureFlag(string id)
will now returnnull
if the Feature Flag does not exist.FEATURE_FLAGS_UPDATED
will only trigger when a refresh request completes with success or failure, and upon initial subscription if there was previously cached data from the current session.
Fixed
- Fixed an issue introduced in
4.0.0
which prevented compilation on Xcode 14.3+.- The additional
-fcxx-modules
flag under "Other C++ Flags" has been removed from the build process. - The dependencies
BrazeKit
andBrazeUI
now get directly linked to the main app's target, instead of being transitively linked viaUnityFramework
.
- The additional
- Changed the iOS plugin to automatically update up to the next minor version, instead of up to the next major version.
4.3.0
4.3.0
Starting with this release, this SDK will use Semantic Versioning.
Changed
- Updated the Android plugin to use Braze Android SDK 27.0.1.
4.2.0
4.2.0
Breaking
- Updated the Android plugin to use Braze Android SDK 26.2.0
Fixed
- Fixed an issue on Android where In-App Message events would not properly get forwarded to the Unity layer.
4.1.1
4.1.0
Added
- Added support for Feature Flags.
AppboyBinding.GetFeatureFlag(string id)
- Get a single Feature Flag.AppboyBinding.GetAllFeatureFlags()
- Get all Feature Flags.AppboyBinding.RefreshFeatureFlags()
- Request a refresh of Feature Flags.
- Adds the ability to subscribe to Feature Flag updates.
- Set the values for
Game Object Name
andCallback Method Name
under "Braze Configuration" > "Feature Flags" to the corresponding values in your application.
- Set the values for
- On
FeatureFlag
object, adds these APIs to get specific properties:featureFlag.getStringProperty(string id)
featureFlag.getIntegerProperty(string id)
featureFlag.getDoubleProperty(string id)
featureFlag.getBooleanProperty(string id)
- Updated the iOS plugin to use the Braze Swift SDK 6.1.0.
4.0.0
4.0.0
Breaking
- Updated the Android plugin to use Braze Android SDK 25.0.0
- Updates the native iOS bridge to use the new Swift SDK version 6.0.0.
- Replace any instances of
#import <Appboy_iOS_SDK/AppboyKit.h>
in your iOS native code with:
@import BrazeKit; @import BrazeUI; // Only needed if you use the UI in the file
- Replace the prefix
ABK
withBRZ
for any of the constants found in AppboyUnityManager.h. - Update your
AppDelegate
file with the code snippet below. Reference our sample code here.
BRZConfiguration *config = [[BRZConfiguration alloc] init]; Braze *braze = [AppboyUnityManager initBraze:config];
- Reference this Migration Guide and this documentation for additional context around specific migration / integration steps.
- Replace any instances of
- Requires Unity version 2020.3.42 or newer.
- The following changes have been made to
AppboyUnityManager.h
:- Renames
addInAppMessageListenerWithObjectNameAndSetDelegate:callbackMethodName:
toaddInAppMessageListenerWithObjectName:callbackMethodName:
. - Renames
ABKUnityMessageType
toBRZUnityMessageType
. - Removes
parsePlist
since it is implemented as a part ofinitBraze:
.
- Renames
- Removes
setFacebookData
andsetTwitterData
fromAppboyBinding.cs
. - Removes the release asset
Appboy-nodeps.unitypackage
in favor of using the "Braze Configuration" option mentioned below.
Added
- Adds a configuration option under "Braze Configuration" which allows you to toggle between importing
SDWebImage
into your iOS application.- If checked, the build process will automatically add SDWebImage version 5.15.5 to your project. If unchecked, it will be omitted.