Updating Braze SDK

Appboy-iOS-SDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "Appboy-iOS-SDK"
-  s.version      = "4.4.3"
+  s.version      = "4.4.4"
   s.summary      = "This is the Braze iOS SDK for Mobile Marketing Automation"
   s.homepage     = "http://www.braze.com"
   s.license      = { :type => 'Commercial', :text => 'Please refer to https://github.com/Appboy/appboy-ios-sdk/blob/master/LICENSE'}

Appboy-tvOS-SDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "Appboy-tvOS-SDK"
-  s.version      = "4.4.3"
+  s.version      = "4.4.4"
   s.summary      = "This is the Braze tvOS SDK for Mobile Marketing Automation"
   s.homepage     = "http://www.braze.com"
   s.license      = { :type => 'Commercial', :text => 'Please refer to https://github.com/Appboy/appboy-ios-sdk/blob/master/LICENSE'}

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKBannerCard.h

@@ -18,7 +18,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (copy, nullable) NSString *domain;
 
 /*
- * This property is the aspect ratio of the card's image.
+ * This property is the aspect ratio of the card's image. It is meant to serve as a hint before
+ * image loading completes. Note that the property may not be supplied in certain circumstances.
  */
 @property float imageAspectRatio;
 

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKBannerContentCard.h

@@ -8,7 +8,8 @@
 @property (copy) NSString *image;
 
 /*
- * This property is the aspect ratio of the card's image.
+ * This property is the aspect ratio of the card's image. It is meant to serve as a hint before
+ * image loading completes. Note that the property may not be supplied in certain circumstances.
  */
 @property float imageAspectRatio;
 

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKCaptionedImageCard.h

@@ -12,7 +12,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (copy) NSString *image;
 
 /*
- * This property is the aspect ratio of the card's image.
+ * This property is the aspect ratio of the card's image. It is meant to serve as a hint before
+ * image loading completes. Note that the property may not be supplied in certain circumstances.
  */
 @property float imageAspectRatio;
 

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKCaptionedImageContentCard.h

@@ -9,7 +9,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (copy) NSString *image;
 
 /*
- * This property is the aspect ratio of the card's image.
+ * This property is the aspect ratio of the card's image. It is meant to serve as a hint before
+ * image loading completes. Note that the property may not be supplied in certain circumstances.
  */
 @property float imageAspectRatio;
 

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKSdkMetadata.h

@@ -0,0 +1,39 @@
+/*!
+ * Enum representing the accepted SDK Metatadata.
+ * See addSdkMetadata for more details.
+ */
+typedef NSString *ABKSdkMetadata NS_TYPED_EXTENSIBLE_ENUM;
+extern ABKSdkMetadata const ABKSdkMetadataAdjust;
+extern ABKSdkMetadata const ABKSdkMetadataAirBridge;
+extern ABKSdkMetadata const ABKSdkMetadataAppsFlyer;
+extern ABKSdkMetadata const ABKSdkMetadataBluedot;
+extern ABKSdkMetadata const ABKSdkMetadataBranch;
+extern ABKSdkMetadata const ABKSdkMetadataCordova;
+extern ABKSdkMetadata const ABKSdkMetadataCarthage;
+extern ABKSdkMetadata const ABKSdkMetadataCocoaPods;
+extern ABKSdkMetadata const ABKSdkMetadataCordovaPM;
+extern ABKSdkMetadata const ABKSdkMetadataExpo;
+extern ABKSdkMetadata const ABKSdkMetadataFoursquare;
+extern ABKSdkMetadata const ABKSdkMetadataFlutter;
+extern ABKSdkMetadata const ABKSdkMetadataGoogleTagManager;
+extern ABKSdkMetadata const ABKSdkMetadataGimbal;
+extern ABKSdkMetadata const ABKSdkMetadataGraddle;
+extern ABKSdkMetadata const ABKSdkMetadataIonic;
+extern ABKSdkMetadata const ABKSdkMetadataKochava;
+extern ABKSdkMetadata const ABKSdkMetadataManual;
+extern ABKSdkMetadata const ABKSdkMetadataMParticle;
+extern ABKSdkMetadata const ABKSdkMetadataNativeScript;
+extern ABKSdkMetadata const ABKSdkMetadataNPM;
+extern ABKSdkMetadata const ABKSdkMetadataNuGet;
+extern ABKSdkMetadata const ABKSdkMetadataPub;
+extern ABKSdkMetadata const ABKSdkMetadataRadar;
+extern ABKSdkMetadata const ABKSdkMetadataReactNative;
+extern ABKSdkMetadata const ABKSdkMetadataSegment;
+extern ABKSdkMetadata const ABKSdkMetadataSingular;
+extern ABKSdkMetadata const ABKSdkMetadataSwiftPM;
+extern ABKSdkMetadata const ABKSdkMetadataTealium;
+extern ABKSdkMetadata const ABKSdkMetadataUnreal;
+extern ABKSdkMetadata const ABKSdkMetadataUnityPM;
+extern ABKSdkMetadata const ABKSdkMetadataUnity;
+extern ABKSdkMetadata const ABKSdkMetadataVizbee;
+extern ABKSdkMetadata const ABKSdkMetadataXamarin;

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/ABKUser.h

@@ -153,6 +153,22 @@ typedef NS_ENUM(NSInteger, ABKNotificationSubscriptionType) {
  */
 - (BOOL)setPushNotificationSubscriptionType:(ABKNotificationSubscriptionType)pushNotificationSubscriptionType;
 
+/*!
+ * Adds the user to a Subscription Group.
+ *
+ * @param groupId The string UUID corresponding to the subscription group, provided by the Braze dashboard.
+ * @return YES if the user was successfully added, else NO. If not, the groupId might have been nil or invalid.
+ */
+- (BOOL)addToSubscriptionGroupWithGroupId:(NSString *)groupId;
+
+/*!
+ * Removes the user from a Subscription Group.
+ *
+ * @param groupId The string UUID corresponding to the subscription group, provided by the Braze dashboard.
+ * @return YES if the user was successfully removed, else NO. If not, the groupId might have been nil or invalid.
+ */
+- (BOOL)removeFromSubscriptionGroupWithGroupId:(NSString *)groupId;
+
 /*!
  * @param key The String name of the custom user attribute
  * @param value A boolean value to set as a custom attribute

Appboy-tvOS-SDK/AppboyTVOSKit.framework/Headers/Appboy.h

@@ -12,8 +12,10 @@
 #import <UIKit/UIKit.h>
 #import <UserNotifications/UserNotifications.h>
 
+#import "ABKSdkMetadata.h"
+
 #ifndef APPBOY_SDK_VERSION
-#define APPBOY_SDK_VERSION @"4.3.2"
+#define APPBOY_SDK_VERSION @"4.4.4"
 #endif
 
 #if !TARGET_OS_TV
@@ -152,13 +154,24 @@ extern NSString *const ABKDeviceAllowlistKey;
  */
 extern NSString *const ABKDeviceWhitelistKey __deprecated_msg("ABKDeviceWhitelistKey is deprecated. Please use ABKDeviceAllowlistKey instead.");
 
+extern NSString *const ABKEphemeralEventsKey;
+
 /*!
  * This key can be set to a string value representing the app group name for the Push Story Notification
  * Content extension. This is required for the SDK to fetch data from and handle user interactions
  * with the Push Story app extension.
  */
 extern NSString *const ABKPushStoryAppGroupKey;
 
+/*!
+ * This key can be set to an integer value to specify the level of the log statements output by the Braze SDK.
+ *
+ * The default log level is 8 and will minimally log info. To enable verbose logging for debugging, use log level 0.
+ *
+ * This selection will override any LogLevel value set in the Info.plist.
+ */
+extern NSString *const ABKLogLevelKey;
+
 /* ------------------------------------------------------------------------------------------------------
  * Enums
  */
@@ -268,8 +281,7 @@ typedef NS_ENUM(NSInteger, ABKChannel) {
  * @param apiKey The app's API key
  * @param application The current app
  * @param launchOptions The options NSDictionary that you get from application:didFinishLaunchingWithOptions
- * @param appboyOptions An optional NSDictionary with startup configuration values for Braze. This currently supports
- * ABKRequestProcessingPolicyOptionKey, ABKSocialAccountAcquisitionPolicyOptionKey and ABKFlushIntervalOptionKey. See below
+ * @param appboyOptions An optional NSDictionary with startup configuration values for Braze. See below
  * for more information.
  *
  * @discussion Starts up Braze and tells it that your app is done launching. You should call this
@@ -378,7 +390,8 @@ typedef NS_ENUM(NSInteger, ABKChannel) {
 * @param userId The new user's ID (from the host application).
 *
 * @discussion
-* This method changes the user's ID.
+* This method changes the user's ID. These user IDs should be private and not easily obtained (e.g. not a plain
+* email address or username).
 *
 * When you first start using Braze on a device, the user is considered "anonymous". You can use this method to
 * optionally identify a user with a unique ID, which enables the following:
@@ -630,6 +643,15 @@ didReceiveNotificationResponse:(UNNotificationResponse *)response
 
 #endif
 
+/*!
+ * Adds SDK Metadata values to those automatically collected by the SDK.
+ *
+ * Metadata tell Braze how the SDK is integrated (e.g. wrapper, package manager, etc.)
+ *
+ * @param metadata The metadata values reflecting the current SDK integration.
+ */
+- (void)addSdkMetadata:(NSArray<ABKSdkMetadata> *)metadata;
+
 /* ------------------------------------------------------------------------------------------------------
  * Data processing configuration methods.
  */

AppboyKit/include/ABKInAppMessageWebViewBridge.h

@@ -41,13 +41,19 @@ NS_ASSUME_NONNULL_BEGIN
 @protocol ABKInAppMessageWebViewBridgeDelegate <NSObject>
 
 /*!
- * Tells the delegate the bridge has received a click action to execute
+ * Tells the delegate that the bridge has received a click action to execute
  * @param webViewBridge The bridge informing the delegate
  * @param clickAction The clickAction performed
  */
 - (void)webViewBridge:(ABKInAppMessageWebViewBridge *)webViewBridge
   receivedClickAction:(ABKInAppMessageClickActionType)clickAction;
 
+/*!
+ * Tells the delegate that a close message action was received
+ * @param webViewBridge The bridge informing the delegate
+ */
+- (void)closeMessageWithWebViewBridge:(ABKInAppMessageWebViewBridge *)webViewBridge;
+
 @end
 
 NS_ASSUME_NONNULL_END

AppboyKit/include/Appboy.h

@@ -15,7 +15,7 @@
 #import "ABKSdkMetadata.h"
 
 #ifndef APPBOY_SDK_VERSION
-#define APPBOY_SDK_VERSION @"4.4.3"
+#define APPBOY_SDK_VERSION @"4.4.4"
 #endif
 
 #if !TARGET_OS_TV

AppboyUI/ABKInAppMessage/ViewControllers/ABKInAppMessageHTMLBaseViewController.m

@@ -199,7 +199,6 @@ - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigati
       NSLog(@"In-app message body click not registered. Automatic body clicks are disabled.");
     }
   }
-
   [parentViewController inAppMessageClickedWithActionType:self.inAppMessage.inAppMessageClickActionType
                                                       URL:url
                                          openURLInWebView:[self getOpenURLInWebView:queryParams]];
@@ -417,11 +416,20 @@ - (void)webViewBridge:(ABKInAppMessageWebViewBridge *)webViewBridge
   receivedClickAction:(ABKInAppMessageClickActionType)clickAction {
   ABKInAppMessageWindowController *parentViewController =
     (ABKInAppMessageWindowController *)self.parentViewController;
-  
+
   [self.inAppMessage setInAppMessageClickAction:clickAction withURI:nil];
   [parentViewController inAppMessageClickedWithActionType:self.inAppMessage.inAppMessageClickActionType
                                                       URL:nil
                                          openURLInWebView:false];
 }
 
+- (void)closeMessageWithWebViewBridge:(ABKInAppMessageWebViewBridge *)webViewBridge {
+  ABKInAppMessageWindowController *parentViewController =
+    (ABKInAppMessageWindowController *)self.parentViewController;
+  if ([parentViewController.inAppMessageUIDelegate respondsToSelector:@selector(onInAppMessageDismissed:)]) {
+    [parentViewController.inAppMessageUIDelegate onInAppMessageDismissed:self.inAppMessage];
+  }
+  [super hideInAppMessage:self.inAppMessage.animateOut];
+}
+
 @end

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.4.4
+
+##### Fixed
+- Calling `appboyBridge.closeMessage()` or `brazeBridge.closeMessage()` from an HTML in-app message now correctly triggers `ABKInAppMessageUIDelegate.onInAppMessageDismissed:` when implemented.
+- Fixes an issue in `4.4.3` where the tvOS SDK incorrectly referenced an older SDK version.
+
 ## 4.4.3
 
 ##### Fixed

Example/Stopwatch.xcodeproj/project.pbxproj

@@ -1301,7 +1301,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "Apple Development";
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 4.4.3;
+				CURRENT_PROJECT_VERSION = 4.4.4;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
@@ -1357,7 +1357,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "Apple Distribution";
 				COPY_PHASE_STRIP = YES;
-				CURRENT_PROJECT_VERSION = 4.4.3;
+				CURRENT_PROJECT_VERSION = 4.4.4;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_NO_COMMON_BLOCKS = YES;

Example/Stopwatch/Supporting Files/Info.plist

@@ -5,7 +5,7 @@
 
 
 	<key>CFBundleShortVersionString</key>
-	<string>4.4.3</string>
+	<string>4.4.4</string>
 	<key>CFBundleVersion</key>
 	<string>1</string>
 	<key>CFBundleDevelopmentRegion</key>

HelloSwift/HelloSwiftTests/AppboyPushUnitTests.m

@@ -8,8 +8,8 @@
  * A collection of test cases to verify a successful implementation of push
  * notifications using Braze.
 
- * In a unit testing target, as long as the `AppboyPushTests` module is included,
- * the target will run all of this class's unit tests. No added code is required.
+ * In a unit testing target, as long as this file is included,
+ * the target will run all of this class's unit tests. No additional code is required.
  *
  * @seealso https://www.braze.com/docs/developer_guide/platform_integration_guides/ios/push_notifications/integration/
  */

Package.swift

@@ -19,8 +19,8 @@ let package = Package(
   targets: [
     .binaryTarget(
       name: "AppboyKitLibrary",
-      url: "https://github.com/Appboy/appboy-ios-sdk/releases/download/4.4.3/AppboyKitLibrary.xcframework.zip",
-      checksum: "66f13ebff3323d7eeccfba4fb67ab2174402a2b021c6b5a28990737316041510"
+      url: "https://github.com/Appboy/appboy-ios-sdk/releases/download/4.4.4/AppboyKitLibrary.xcframework.zip",
+      checksum: "bf9170291c7eb894a4d96c0e11bcd6b5de90391795919223e59342df0827064b"
     ),
     .target(
       name: "AppboyKit",
@@ -53,8 +53,8 @@ let package = Package(
     ),
     .binaryTarget(
       name: "AppboyPushStoryFramework",
-      url: "https://github.com/Appboy/appboy-ios-sdk/releases/download/4.4.3/AppboyPushStoryFramework.xcframework.zip",
-      checksum: "950a16e8d8ad665f92986d4d0af405316ea28b2655228ac798d0f156ca892718"
+      url: "https://github.com/Appboy/appboy-ios-sdk/releases/download/4.4.4/AppboyPushStoryFramework.xcframework.zip",
+      checksum: "ce8f7999106a7f14400a18c18037dbc0bc44b925086514835ec86db0f06c839f"
     ),
     .target(
       name: "AppboyPushStory",

README.md

@@ -2,7 +2,7 @@
 
 </br>
 
-<img src="https://github.com/Appboy/appboy-ios-sdk/blob/master/braze-logo.png" width="300" title="Braze Logo" />
+<img src="braze-logo.png" width="300" title="Braze Logo" />
 
 # iOS SDK