Merge pull request #1122 from BranchMetrics/CORE-1589-share-sheet-configuration

Core 1589 share sheet configuration

Author: echo-branch

Branch-SDK/BranchShareLink.h

@@ -7,6 +7,7 @@
 //
 
 #import "BranchUniversalObject.h"
+#import <LinkPresentation/LinkPresentation.h>
 @class BranchShareLink;
 
 @protocol BranchShareLinkDelegate <NSObject>
@@ -55,7 +56,7 @@ A delegate on the BranchShareLink can further configure the share experience. Fo
 parameters can be changed depending on the activity that the user selects.
 */
 
-@interface BranchShareLink : NSObject
+@interface BranchShareLink : NSObject <UIActivityItemSource>
 
 /**
 Creates a BranchShareLink object.
@@ -91,6 +92,9 @@ Presents a UIActivityViewController that shares the Branch link.
 // By default, we use the Branch bnc.lt link, but if you wish more control override it here.
 @property (nonatomic, strong, nullable) NSURL *placeholderURL;
 
+// iOS 13+ : LinkPresentation metadata for the preview header.
+@property (nonatomic, strong, nullable) LPLinkMetadata *lpMetaData API_AVAILABLE(ios(13.0));
+
 ///Share text for the item.  This is not the text in the iOS 13+ preview header.
 ///This text can be changed later when the `branchShareSheetWillShare:` delegate method is called.
 @property (nonatomic, strong) NSString*_Nullable shareText;
@@ -120,4 +124,8 @@ Presents a UIActivityViewController that shares the Branch link.
 
 ///The delegate. See 'BranchShareLinkDelegate' above for a description.
 @property (nonatomic, weak)   id<BranchShareLinkDelegate>_Nullable delegate;
+
+@property void (^ _Nullable completion)(NSString * _Nullable activityType, BOOL completed);
+@property void (^ _Nullable completionError)(NSString * _Nullable activityType, BOOL completed, NSError*_Nullable error);
+
 @end

Branch-SDK/BranchShareLink.m

@@ -101,6 +101,11 @@ - (void) shareDidComplete:(BOOL)completed activityError:(NSError*)error {
     if (completed && !error) {
         [[BranchEvent customEventWithName:BNCShareCompletedEvent contentItem:self.universalObject] logEvent];
     }
+    if (self.completion)
+        self.completion(self.activityType, completed);
+    else
+        if (self.completionError)
+            self.completionError(self.activityType, completed, error);
 }
 
 - (NSArray<UIActivityItemProvider*>*_Nonnull) activityItems {
@@ -172,6 +177,12 @@ - (void) shareDidComplete:(BOOL)completed activityError:(NSError*)error {
         [_activityItems addObject:item];
     }
 
+    if (@available(iOS 13.0, *)) {
+        if (self.lpMetaData) {
+            [_activityItems addObject:self];
+        }
+    }
+ 
     return _activityItems;
 }
 
@@ -188,6 +199,7 @@ - (void) presentActivityViewControllerFromViewController:(UIViewController*_Null
 
         shareViewController.completionWithItemsHandler =
             ^ (NSString *activityType, BOOL completed, NSArray *returnedItems, NSError *activityError) {
+                self->_activityType = activityType;
                 [self shareDidComplete:completed activityError:activityError];
             };
 
@@ -197,6 +209,7 @@ - (void) presentActivityViewControllerFromViewController:(UIViewController*_Null
         #pragma clang diagnostic ignored "-Wdeprecated-declarations"
         shareViewController.completionHandler =
             ^ (UIActivityType activityType, BOOL completed) {
+                self->_activityType = activityType;
                 [self shareDidComplete:completed activityError:nil];
             };
         #pragma clang diagnostic pop
@@ -311,4 +324,20 @@ - (BOOL) returnURL {
     return returnURL;
 }
 
+- (id)activityViewControllerPlaceholderItem:(UIActivityViewController *)activityViewController  // called to determine data type. only the class of the return type is consulted. it should match what -itemForActivityType: returns later
+{
+    return @"";
+}
+
+- (nullable LPLinkMetadata *)activityViewControllerLinkMetadata:(UIActivityViewController *)activityViewController API_AVAILABLE(ios(13.0))
+{
+    return self.lpMetaData;
+}
+
+- (nullable id)activityViewController:(UIActivityViewController *)activityViewController itemForActivityType:(nullable UIActivityType)activityType   // called to fetch data after an activity is selected. you can return nil.
+{
+    return nil;
+}
+
+
 @end

Branch-SDK/BranchUniversalObject.h

@@ -194,8 +194,6 @@ FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionRefurbished;
 /// @name Share Sheet Handling
 #if !TARGET_OS_TV
 
-- (nullable UIActivityItemProvider *)getBranchActivityItemWithLinkProperties:(nonnull BranchLinkProperties *)linkProperties;
-
 - (void)showShareSheetWithShareText:(nullable NSString *)shareText
                          completion:(void (^ _Nullable)(NSString * _Nullable activityType, BOOL completed))completion;
 

Branch-SDK/BranchUniversalObject.m

@@ -413,26 +413,6 @@ - (NSString *)getLongUrlWithChannel:(NSString *)channel
 #pragma mark - Share Sheets
 #if !TARGET_OS_TV
 
-- (UIActivityItemProvider *)getBranchActivityItemWithLinkProperties:(BranchLinkProperties *)linkProperties {
-    if (!self.canonicalIdentifier && !self.canonicalUrl && !self.title) {
-        BNCLogWarning(@"A canonicalIdentifier, canonicalURL, or title are required to uniquely identify content. "
-            "In order to not break the end user experience with sharing, Branch SDK will proceed to create a URL, "
-            "but content analytics may not properly include this URL.");
-    }
-    
-    NSMutableDictionary *params = [[self getParamsForServerRequestWithAddedLinkProperties:linkProperties] mutableCopy];
-    if (linkProperties.matchDuration) {
-        [params setObject:@(linkProperties.matchDuration) forKey:BRANCH_REQUEST_KEY_URL_DURATION];
-    }
-
-    return [Branch getBranchActivityItemWithParams:params
-                                           feature:linkProperties.feature
-                                             stage:linkProperties.stage
-                                          campaign:linkProperties.campaign
-                                              tags:linkProperties.tags
-                                             alias:linkProperties.alias];
-}
-
 - (void)showShareSheetWithShareText:(NSString *)shareText
                          completion:(void (^ _Nullable)(NSString * _Nullable activityType, BOOL completed))completion {
     [self showShareSheetWithLinkProperties:nil andShareText:shareText fromViewController:nil completion:completion];
@@ -478,79 +458,12 @@ - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties
                                   anchor:(nullable id)anchorViewOrButtonItem
                               completion:(void (^ _Nullable)(NSString * _Nullable activityType, BOOL completed))completion
                    orCompletionWithError:(void (^ _Nullable)(NSString * _Nullable activityType, BOOL completed, NSError*_Nullable error))completionError {
-
-    // Log share initiated event
-    [[BranchEvent customEventWithName:BNCShareInitiatedEvent contentItem:self] logEvent];
-    UIActivityItemProvider *itemProvider = [self getBranchActivityItemWithLinkProperties:linkProperties];
-    NSMutableArray *items = [NSMutableArray arrayWithObject:itemProvider];
-    if (shareText) {
-        [items insertObject:shareText atIndex:0];
-    }
-    UIActivityViewController *shareViewController =
-        [[UIActivityViewController alloc] initWithActivityItems:items applicationActivities:nil];
-    
-    if ([shareViewController respondsToSelector:@selector(completionWithItemsHandler)]) {
-        shareViewController.completionWithItemsHandler =
-          ^(NSString *activityType, BOOL completed, NSArray *returnedItems, NSError *activityError) {
-            // Log share completed event
-            if (completed && !activityError) {
-                [[BranchEvent customEventWithName:BNCShareCompletedEvent contentItem:self] logEvent];
-            }
-            if (completion)
-                completion(activityType, completed);
-            else
-            if (completionError)
-                completionError(activityType, completed, activityError);
-        };
-    } else {
-        #pragma clang diagnostic push
-        #pragma clang diagnostic ignored "-Wdeprecated-declarations"
-        // Deprecated in iOS 8.  Safe to hide deprecation warnings as the new completion handler is checked for above
-        shareViewController.completionHandler = completion;
-        #pragma clang diagnostic pop
-    }
-    
-    UIViewController *presentingViewController = nil;
-    if (viewController && [viewController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
-        presentingViewController = viewController;
-    }
-    else {
-        UIViewController *rootViewController = [UIViewController bnc_currentViewController];
-        if ([rootViewController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
-            presentingViewController = rootViewController;
-        }
-    }
-    
-    if (linkProperties.controlParams[BRANCH_LINK_DATA_KEY_EMAIL_SUBJECT]) {
-        @try {
-            [shareViewController setValue:linkProperties.controlParams[BRANCH_LINK_DATA_KEY_EMAIL_SUBJECT] forKey:@"subject"];
-        }
-        @catch (NSException*) {
-            BNCLogWarning(@"Unable to setValue 'emailSubject' forKey 'subject' on UIActivityViewController.");
-        }
-    }
 
-    if (presentingViewController) {
-        // Required for iPad/Universal apps on iOS 8+
-        if ([presentingViewController respondsToSelector:@selector(popoverPresentationController)]) {
-            if ([anchorViewOrButtonItem isKindOfClass:UIBarButtonItem.class]) {
-                UIBarButtonItem *anchor = (UIBarButtonItem*) anchorViewOrButtonItem;
-                shareViewController.popoverPresentationController.barButtonItem = anchor;
-            } else
-            if ([anchorViewOrButtonItem isKindOfClass:UIView.class]) {
-                UIView *anchor = (UIView*) anchorViewOrButtonItem;
-                shareViewController.popoverPresentationController.sourceView = anchor;
-                shareViewController.popoverPresentationController.sourceRect = anchor.bounds;
-            } else {
-                shareViewController.popoverPresentationController.sourceView = presentingViewController.view;
-                shareViewController.popoverPresentationController.sourceRect = CGRectMake(0.0, 0.0, 40.0, 40.0);
-            }
-        }
-        [presentingViewController presentViewController:shareViewController animated:YES completion:nil];
-    }
-    else {
-        BNCLogWarning(@"Unable to show the share sheet since no view controller is present.");
-    }
+    BranchShareLink *shareLink = [[BranchShareLink alloc] initWithUniversalObject:self linkProperties:linkProperties];
+    shareLink.shareText = shareText;
+    shareLink.completion = completion;
+    shareLink.completionError = completionError;
+    [shareLink presentActivityViewControllerFromViewController:viewController anchor:anchorViewOrButtonItem];
 }
 
 #pragma mark - Spotlight

Branch-TestBed/Branch-TestBed/ViewController.m

@@ -15,6 +15,7 @@
 #import "BranchLinkProperties.h"
 #import "LogOutputViewController.h"
 #import "AppDelegate.h"
+#import <LinkPresentation/LinkPresentation.h>
 
 extern AppDelegate* appDelegate;
 
@@ -338,7 +339,16 @@ - (IBAction)shareLinkButtonTouchUpInside:(id)sender {
     shareLink.shareText = [NSString stringWithFormat:
         @"Shared from Branch-TestBed at %@.",
         [self.dateFormatter stringFromDate:[NSDate date]]];
-
+    
+    if (@available(iOS 13.0, *)) {
+        LPLinkMetadata *tempLinkMetatData = [[LPLinkMetadata alloc] init];
+        tempLinkMetatData.title = @"Branch URL";
+        UIImage *img = [UIImage imageNamed:@"Brand Assets"];
+        tempLinkMetatData.iconProvider = [[NSItemProvider alloc] initWithObject:img];
+        tempLinkMetatData.imageProvider = [[NSItemProvider alloc] initWithObject:img];
+        shareLink.lpMetaData = tempLinkMetatData;
+    }
+   
     [shareLink presentActivityViewControllerFromViewController:self anchor:sender];
 }