Merge pull request #220 from apptentive/branch_5.2.0

Release 5.2.0

Author: weeeBox

Apptentive/Apptentive.xcodeproj/project.pbxproj

@@ -2382,7 +2382,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 15;
+				CURRENT_PROJECT_VERSION = 16;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -2440,7 +2440,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 15;
+				CURRENT_PROJECT_VERSION = 16;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_NS_ASSERTIONS = NO;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
@@ -2472,7 +2472,7 @@
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = 86WML2UN43;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 15;
+				DYLIB_CURRENT_VERSION = 16;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				GCC_PREFIX_HEADER = "Apptentive/Misc/ApptentiveConnect-Prefix.pch";
 				GCC_PREPROCESSOR_DEFINITIONS = "APPTENTIVE_DEBUG=1";
@@ -2494,7 +2494,7 @@
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = 86WML2UN43;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 15;
+				DYLIB_CURRENT_VERSION = 16;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				GCC_PREFIX_HEADER = "Apptentive/Misc/ApptentiveConnect-Prefix.pch";
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;

Apptentive/Apptentive/Apptentive.h

@@ -20,7 +20,7 @@ FOUNDATION_EXPORT double ApptentiveVersionNumber;
 FOUNDATION_EXPORT const unsigned char ApptentiveVersionString[];
 
 /** The version number of the Apptentive SDK. */
-#define kApptentiveVersionString @"5.1.2"
+#define kApptentiveVersionString @"5.2.0"
 
 /** The version number of the Apptentive API platform. */
 #define kApptentiveAPIVersionString @"9"
@@ -61,6 +61,9 @@ typedef NS_ENUM(NSInteger, ApptentiveAuthenticationFailureReason) {
 /** A block used to notify your app that an authenticated request failed to authenticate. */
 typedef void (^ApptentiveAuthenticationFailureCallback)(ApptentiveAuthenticationFailureReason reason, NSString *errorMessage);
 
+/** A block used to interact with the default engagement flow. */
+typedef BOOL (^ApptentiveInteractionCallback)(NSString *eventName, NSDictionary * _Nullable customData);
+
 @protocol ApptentiveDelegate
 , ApptentiveStyle;
 
@@ -782,6 +785,12 @@ typedef NS_ENUM(NSUInteger, ApptentiveLogLevel) {
  */
 @property (copy, nonatomic) ApptentiveAuthenticationFailureCallback authenticationFailureCallback;
 
+/**
+ A block that is called right before engaging an interaction. Return `NO` to cancel
+ the engagement.
+ */
+@property (copy, nonatomic) ApptentiveInteractionCallback preInteractionCallback;
+
 /**
  Updates the login token with the provided one. Used to refresh a token that has expired or may expire soon.
 

Apptentive/Apptentive/Apptentive.m

@@ -541,6 +541,26 @@ - (void)engage:(NSString *)event withCustomData:(nullable NSDictionary *)customD
 			};
 		}
 
+		// first, we check if there's an engagement callback to inject
+		if (self.preInteractionCallback) {
+			BOOL canShowInteraction = [self.backend canShowInteractionForLocalEvent:event];
+			if (!canShowInteraction) {
+				if (wrappedCompletion) {
+					wrappedCompletion(NO);
+				}
+				return;
+			}
+			
+			BOOL allowsInteraction = self.preInteractionCallback(event, customData);
+			ApptentiveLogInfo(@"Engagement callback allows interaction for event '%@': %@", event, allowsInteraction ? @"YES" : @"NO");
+			if (!allowsInteraction) {
+				if (wrappedCompletion) {
+					wrappedCompletion(NO);
+				}
+				return;
+			}
+		}
+		
 		[self.backend engageLocalEvent:event userInfo:nil customData:customData extendedData:extendedData fromViewController:viewController completion:wrappedCompletion];
 	}];
 }

Apptentive/Apptentive/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.1.2</string>
+	<string>5.2.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

Apptentive/ApptentiveTests/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.1.2</string>
+	<string>5.2.0</string>
 	<key>CFBundleVersion</key>
 	<string>1</string>
 </dict>

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2018-08-23 - v5.2.0
+
+#### Improvements
+
+* Added `preInteractionCallback` to intercept interactions flow.
+
 # 2018-07-05 - v5.1.2
 
 #### Improvements

Example/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - apptentive-ios (5.1.2)
+  - apptentive-ios (5.2.0)
 
 DEPENDENCIES:
   - apptentive-ios (from `..`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: ..
 
 SPEC CHECKSUMS:
-  apptentive-ios: 40ef4adae30fc945684ffd225df1db7748d93c86
+  apptentive-ios: fafd22764202d97acc37f097d8460a56b704d767
 
 PODFILE CHECKSUM: 89d2b5f4683b04482e89df6d46b268cc9ed1ef79
 

apptentive-ios.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name     = 'apptentive-ios'
   s.module_name = 'Apptentive'
-  s.version  = '5.1.2'
+  s.version  = '5.2.0'
   s.license  = 'BSD'
   s.summary  = 'Apptentive Customer Communications SDK.'
   s.homepage = 'https://www.apptentive.com/'