Add Receive Receipt call

  * Send receice receipt call whenever a notification arrives to the cellphone

Author: Jeasmine

iOS_SDK/OneSignalDevApp/OneSignalDevApp/Info.plist

@@ -29,6 +29,8 @@
 	<string>Test Location</string>
 	<key>NSLocationWhenInUseUsageDescription</key>
 	<string>Test Location2</string>
+	<key>OneSignal_disable_badge_clearing</key>
+	<false/>
 	<key>OneSignal_require_privacy_consent</key>
 	<false/>
 	<key>UIBackgroundModes</key>
@@ -43,8 +45,6 @@
 	<array>
 		<string>armv7</string>
 	</array>
-	<key>OneSignal_disable_badge_clearing</key>
-	<false/>
 	<key>UISupportedInterfaceOrientations</key>
 	<array>
 		<string>UIInterfaceOrientationPortrait</string>

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/.project.pbxproj.swp

@@ -58,7 +58,6 @@
 		4529DEED1FA83C5D00CEAB1D /* OneSignalHelperOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DEEC1FA83C5D00CEAB1D /* OneSignalHelperOverrider.m */; };
 		4529DEF01FA8433500CEAB1D /* NSLocaleOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DEEF1FA8433500CEAB1D /* NSLocaleOverrider.m */; };
 		4529DEF31FA8440A00CEAB1D /* UIAlertViewOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DEF21FA8440A00CEAB1D /* UIAlertViewOverrider.m */; };
-		4529DEF61FA8460C00CEAB1D /* UnitTestAppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DEF51FA8460C00CEAB1D /* UnitTestAppDelegate.m */; };
 		4529DF0C1FA932AC00CEAB1D /* OneSignalTrackFirebaseAnalytics.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DF0B1FA932AC00CEAB1D /* OneSignalTrackFirebaseAnalytics.m */; };
 		454F94F21FAD218000D74CCF /* OneSignalNotificationServiceExtensionHandler.m in Sources */ = {isa = PBXBuildFile; fileRef = 454F94F11FAD218000D74CCF /* OneSignalNotificationServiceExtensionHandler.m */; };
 		454F94F51FAD2E5A00D74CCF /* OSNotificationPayload.m in Sources */ = {isa = PBXBuildFile; fileRef = 454F94F41FAD2E5A00D74CCF /* OSNotificationPayload.m */; };
@@ -107,6 +106,10 @@
 		7AFE856D2368DDB80091D6A5 /* OSFocusCallParams.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AFE856A2368DDB80091D6A5 /* OSFocusCallParams.m */; };
 		7AFE856F2368DDC50091D6A5 /* OSFocusCallParams.h in Headers */ = {isa = PBXBuildFile; fileRef = 7AFE856E2368DDC50091D6A5 /* OSFocusCallParams.h */; };
 		5B58E4F8237CE7B4009401E0 /* UIDeviceOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = 5B58E4F6237CE7B4009401E0 /* UIDeviceOverrider.m */; };
+		7A9173A2231971E5007848FA /* OSReceiveReceiptController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A9173A1231971E5007848FA /* OSReceiveReceiptController.m */; };
+		7ADF891C230DB5BD0054E0D6 /* UnitTestAppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 4529DEF51FA8460C00CEAB1D /* UnitTestAppDelegate.m */; };
+		7ADF891E230DB8290054E0D6 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7ADF891D230DB8290054E0D6 /* CoreGraphics.framework */; };
+		7AF8FDBA2329656E00A19245 /* OneSignalUserDefaults.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AF8FDB92329656E00A19245 /* OneSignalUserDefaults.m */; };
 		911E2CBD1E398AB3003112A4 /* UnitTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 911E2CBC1E398AB3003112A4 /* UnitTests.m */; };
 		911E2CC51E398B53003112A4 /* SystemConfiguration.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3E08E2701D49A5C8002176DE /* SystemConfiguration.framework */; };
 		911E2CC61E398B97003112A4 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 37E6B2BA19D9CAF300D0C601 /* UIKit.framework */; };
@@ -409,6 +412,11 @@
 		7AFE856E2368DDC50091D6A5 /* OSFocusCallParams.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSFocusCallParams.h; sourceTree = "<group>"; };
 		5B58E4F3237CE7B3009401E0 /* UIDeviceOverrider.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = UIDeviceOverrider.h; sourceTree = "<group>"; };
 		5B58E4F6237CE7B4009401E0 /* UIDeviceOverrider.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = UIDeviceOverrider.m; sourceTree = "<group>"; };
+		7A9173A1231971E5007848FA /* OSReceiveReceiptController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSReceiveReceiptController.m; sourceTree = "<group>"; };
+		7A9173A3231971F8007848FA /* OSReceiveReceiptController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSReceiveReceiptController.h; sourceTree = "<group>"; };
+		7ADF891D230DB8290054E0D6 /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
+		7AF8FDB82329655C00A19245 /* OneSignalUserDefaults.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalUserDefaults.h; sourceTree = "<group>"; };
+		7AF8FDB92329656E00A19245 /* OneSignalUserDefaults.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalUserDefaults.m; sourceTree = "<group>"; };
 		911E2CBA1E398AB3003112A4 /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		911E2CBC1E398AB3003112A4 /* UnitTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = UnitTests.m; sourceTree = "<group>"; };
 		911E2CBE1E398AB3003112A4 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -712,6 +720,13 @@
 				9D1BD95B2376622700A064F7 /* Model */,
 			);
 			name = OutcomeEvents;
+		7A9173A023197198007848FA /* ReceiveReceipt */ = {
+			isa = PBXGroup;
+			children = (
+				7A9173A1231971E5007848FA /* OSReceiveReceiptController.m */,
+				7A9173A3231971F8007848FA /* OSReceiveReceiptController.h */,
+			);
+			name = ReceiveReceipt;
 			sourceTree = "<group>";
 		};
 		911E2CBB1E398AB3003112A4 /* UnitTests */ = {
@@ -752,6 +767,7 @@
 			children = (
 				7A674F172360D7DB001F9ACD /* OnFocus */,
 				7ADE379222E8B56F00263048 /* OutcomeEvents */,
+				7A9173A023197198007848FA /* ReceiveReceipt */,
 				454F94F31FAD263300D74CCF /* Model */,
 				9129C6B41E89E541009CB6A0 /* State */,
 				91F58D7B1E7C7EE30017D24D /* NotificationSettings */,
@@ -794,6 +810,8 @@
 				CAABF34A205B15780042F8E5 /* OneSignalExtensionBadgeHandler.m */,
 				CAAEA68621ED68A40049CF15 /* OneSignalNotificationCategoryController.h */,
 				CAAEA68521ED68A30049CF15 /* OneSignalNotificationCategoryController.m */,
+				7AF8FDB82329655C00A19245 /* OneSignalUserDefaults.h */,
+				7AF8FDB92329656E00A19245 /* OneSignalUserDefaults.m */,
 			);
 			path = Source;
 			sourceTree = "<group>";
@@ -1093,7 +1111,7 @@
 					};
 					911E2CB91E398AB3003112A4 = {
 						CreatedOnToolsVersion = 8.1;
-						DevelopmentTeam = 99SW8E36CT;
+						DevelopmentTeam = UKWHJ5PHKD;
 						ProvisioningStyle = Automatic;
 					};
 					CA2951BD2167F9860064227A = {
@@ -1181,6 +1199,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				9D1BD968237A28FC00A064F7 /* OSUniqueOutcomeNotification.m in Sources */,
+				7A9173A2231971E5007848FA /* OSReceiveReceiptController.m in Sources */,
 				9124120E1E73342200E41FD7 /* OneSignal.m in Sources */,
 				CACBAA97218A6243000ACAA5 /* OSMessagingController.m in Sources */,
 				CA36F35921C33A2500300C77 /* OSInAppMessageController.m in Sources */,
@@ -1235,6 +1254,7 @@
 				9129C6BE1E89E7AB009CB6A0 /* OSSubscription.m in Sources */,
 				7AECE59023674A9700537907 /* OSAttributedFocusTimeProcessor.m in Sources */,
 				7ADE379422E8B69C00263048 /* OneSignalOutcomeEventsController.m in Sources */,
+				7AF8FDBA2329656E00A19245 /* OneSignalUserDefaults.m in Sources */,
 				912412361E73342200E41FD7 /* OneSignalTrackIAP.m in Sources */,
 				CAABF34B205B15780042F8E5 /* OneSignalExtensionBadgeHandler.m in Sources */,
 				CACBAA9D218A6243000ACAA5 /* OSInAppMessageView.m in Sources */,
@@ -1404,6 +1424,7 @@
 				4529DEE11FA82AB300CEAB1D /* NSBundleOverrider.m in Sources */,
 				912412441E73342200E41FD7 /* UNUserNotificationCenter+OneSignal.m in Sources */,
 				03866CC12378A67B0009C1D8 /* RestClientAsserts.m in Sources */,
+				7ADF891C230DB5BD0054E0D6 /* UnitTestAppDelegate.m in Sources */,
 				9124123C1E73342200E41FD7 /* OneSignalWebView.m in Sources */,
 				CAB411AE208931EE005A70D1 /* DummyNotificationCenterDelegate.m in Sources */,
 				4529DEF01FA8433500CEAB1D /* NSLocaleOverrider.m in Sources */,

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -186,4 +186,8 @@ -(void)parseOtherApnsFields {
     _category = aps[@"category"];
 }
 
+- (NSString *)description {
+    return [NSString stringWithFormat: @"Photo: notificationID=%@ templateID=%@ templateName=%@ contentAvailable=%@ mutableContent=%@ category=%@ rawPayload=%@", _notificationID, _templateID, _templateName, _contentAvailable ? @"YES" : @"NO", _mutableContent ? @"YES" : @"NO", _category, _rawPayload];
+}
+
 @end

iOS_SDK/OneSignalSDK/Source/OSNotificationPayload.m

@@ -0,0 +1,44 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import "OneSignal.h"
+
+@interface OSReceiveReceiptController : NSObject
+
+- (void)sendReceiveReceiptCachedWithNotification:(NSString *)notificationId;
+
+- (void)sendReceiveReceiptWithPlayerId:(nonnull NSString *)playerId
+                        notificationId:(nonnull NSString *)notificationId
+                                 appId:(nonnull NSString *)appId;
+
+- (void)sendReceiveReceiptWithPlayerId:(nonnull NSString *)playerId
+                        notificationId:(nonnull NSString *)notificationId
+                                 appId:(nonnull NSString *)appId
+                          successBlock:(nullable OSResultSuccessBlock)success
+                          failureBlock:(nullable OSFailureBlock)failure;
+
+@end

iOS_SDK/OneSignalSDK/Source/OSReceiveReceiptController.h

@@ -0,0 +1,86 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import <Foundation/Foundation.h>
+#import "OSReceiveReceiptController.h"
+#import "Requests.h"
+#import "OneSignalClient.h"
+#import "OSSubscription.h"
+#import "OneSignalCommonDefines.h"
+#import "OneSignalUserDefaults.h"
+
+@implementation OSReceiveReceiptController
+
+- (instancetype)init
+{
+    self = [super init];
+    return self;
+}
+
+- (void)sendReceiveReceiptCachedWithNotification:(NSString *)notificationId {
+    NSUserDefaults *userDefaultsShared = [OneSignalSharedUserDefaults getSharedUserDefault];
+    let currentSubscriptionState = [[OSSubscriptionState alloc] initAsFrom];
+    let playerId = [currentSubscriptionState userId];
+    let appId = [userDefaultsShared stringForKey:APP_ID];
+
+    [self sendReceiveReceiptWithPlayerId:playerId notificationId:notificationId appId:appId];
+}
+
+- (void)sendReceiveReceiptWithPlayerId:(NSString *)playerId notificationId:(NSString *)notificationId appId:(NSString *)appId {
+    [self sendReceiveReceiptWithPlayerId:playerId notificationId:notificationId appId:appId successBlock:nil failureBlock:nil];
+}
+
+- (void)sendReceiveReceiptWithPlayerId:(nonnull NSString *)playerId
+                        notificationId:(nonnull NSString *)notificationId
+                                 appId:(nonnull NSString *)appId
+                          successBlock:(nullable OSResultSuccessBlock)success
+                          failureBlock:(nullable OSFailureBlock)failure {
+    let message = [NSString stringWithFormat:@"OneSignal sendReceiveReceiptWithPlayerId playerId:%@ notificationId: %@, appId: %@", playerId, notificationId, appId];
+    [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:message];
+
+    if (![self checkReceiveReceiptsStatus]) {
+        [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"sendReceiveReceiptWithPlayerId disabled"];
+        return;
+    }
+    OSRequestReceiveReceipts *request = [OSRequestReceiveReceipts withPlayerId:playerId notificationId:notificationId appId:appId];
+    
+    [OneSignalClient.sharedClient executeRequest:request onSuccess:^(NSDictionary *result) {
+        if (success) {
+            success(result);
+        }
+    } onFailure:^(NSError *error) {
+        if (failure) {
+            failure(error);
+        }
+    }];
+}
+
+- (BOOL)checkReceiveReceiptsStatus {    
+    return [OneSignalSharedUserDefaults getSavedBool:ONESIGNAL_ENABLE_RECEIVE_RECEIPTS defaultValue:NO];
+}
+
+@end

iOS_SDK/OneSignalSDK/Source/OSReceiveReceiptController.m

@@ -27,7 +27,7 @@
 
 #import "OSSubscription.h"
 #import "OneSignalCommonDefines.h"
-
+#import "OneSignalUserDefaults.h"
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wundeclared-selector"
@@ -44,9 +44,9 @@ - (instancetype)initAsToWithPermision:(BOOL)permission {
     _accpeted = permission;
 
     NSUserDefaults* userDefaults = [NSUserDefaults standardUserDefaults];
-    _userId = [userDefaults stringForKey:USERID];
     _pushToken = [userDefaults stringForKey:DEVICE_TOKEN];
     _userSubscriptionSetting = [userDefaults objectForKey:SUBSCRIPTION] == nil;
+    _userId = [OneSignalSharedUserDefaults getSavedString:USERID_LAST defaultValue:nil];
 
     return self;
 }
@@ -59,12 +59,12 @@ - (BOOL)compare:(OSSubscriptionState*)from {
 }
 
 - (instancetype)initAsFrom {
-    NSUserDefaults* userDefaults = [NSUserDefaults standardUserDefaults];
+    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
 
-    _userId = [userDefaults stringForKey:USERID_LAST];
     _pushToken = [userDefaults stringForKey:PUSH_TOKEN];
     _userSubscriptionSetting = [userDefaults objectForKey:SUBSCRIPTION_SETTING] == nil;
     _accpeted = [userDefaults boolForKey:ACCEPTED_PERMISSION];
+    _userId = [OneSignalSharedUserDefaults getSavedString:USERID_LAST defaultValue:nil];
 
     return self;
 }
@@ -77,10 +77,11 @@ - (void)persistAsFrom {
         strUserSubscriptionSetting = @"no";
 
     [userDefaults setObject:strUserSubscriptionSetting forKey:SUBSCRIPTION_SETTING];
-    [userDefaults setObject:_userId forKey:USERID_LAST];
     [userDefaults setObject:_pushToken forKey:PUSH_TOKEN];
     [userDefaults setBool:_accpeted forKey:ACCEPTED_PERMISSION];
 
+    [OneSignalSharedUserDefaults saveString:_userId withKey:USERID_LAST];
+    
     [userDefaults synchronize];
 }
 
@@ -97,7 +98,6 @@ - (instancetype)copyWithZone:(NSZone*)zone {
     return copy;
 }
 
-
 - (void)onChanged:(OSPermissionState*)state {
     [self setAccepted:state.accepted];
 }