Adds support for Branch.io

.gitmodules

@@ -5,3 +5,6 @@
 [submodule "ADNLogin-SDK-iOS"]
 	path = Dependencies/ADNLogin-SDK
 	url = https://github.com/appdotnet/ADNLogin-SDK-iOS.git
+[submodule "Dependencies/Branch-iOS-SDK"]
+	path = Dependencies/Branch-iOS-SDK
+	url = https://github.com/BranchMetrics/Branch-iOS-SDK

Overshare Kit/OSKPresentationManager.m

@@ -37,6 +37,9 @@
 #import "UIViewController+OSKUtilities.h"
 #import "UIColor+OSKUtility.h"
 
+// --- Branch ---
+#import "Branch.h"
+
 NSString * const OSKPresentationOption_ActivityCompletionHandler = @"OSKPresentationOption_ActivityCompletionHandler";
 NSString * const OSKPresentationOption_PresentationEndingHandler = @"OSKPresentationOption_PresentationEndingHandler";
 
@@ -374,6 +377,11 @@ - (void)tearDownShadowView {
 
 - (void)activitySheet:(OSKActivitySheetViewController *)viewController didSelectActivity:(OSKActivity *)activity {
 
+    // --- Branch ---
+    // Registers that user clicked the share button in the app
+    Branch *branch = [Branch getInstance];
+    [branch userCompletedAction:@"click_share"];
+
     [self _proceedWithSession:viewController.session
              selectedActivity:activity
      presentingViewController:self.presentingViewController
@@ -1159,6 +1167,17 @@ - (void)sessionControllerDidBeginPerformingActivity:(OSKSessionController *)cont
 
 - (void)sessionControllerDidFinish:(OSKSessionController *)controller successful:(BOOL)successful error:(NSError *)error {
 
+
+    // --- Branch ---
+    // Registers if the user was successful or not in sharing
+    Branch *branch = [Branch getInstance];
+    if (successful) {
+        [branch userCompletedAction:@"successful_share"];
+    } else {
+        [branch userCompletedAction:@"failed_share"];
+    }
+
+
     OSKSession *session = controller.session;
     OSKActivity *selectedActivity = controller.activity;
 
@@ -1193,6 +1212,11 @@ - (void)sessionControllerDidCancel:(OSKSessionController *)controller {
      no need to dismiss it.
      */
 
+    // --- Branch ---
+    // Registers that user cancelled the share
+    Branch *branch = [Branch getInstance];
+    [branch userCompletedAction:@"cancelled_share"];
+
     if ([self isPresenting] == NO) {
         // Don't perform the presentation ending block unless the activity sheet
         // has already been dismissed. E.g., on iPad, the session controller

Overshare Kit/OSKShareableContent.h

@@ -137,6 +137,26 @@ These can be custom items, or additional instances of the official items above.
 */
 @property (copy, nonatomic) NSString *title;
 
+
+// ========== Branch ==========
+
+@property (strong, nonatomic) NSMutableArray *channelsToProcessToBranch;
+
+@property (strong, nonatomic) NSMutableArray *channelsWithStringsToProcessToBranch;
+
+@property (strong, nonatomic) NSString *urlToProcessToBranch;
+
+@property (strong, nonatomic) NSArray *branchTags;
+
+@property (strong, nonatomic) NSString *branchFeature;
+
+@property (strong, nonatomic) NSString *branchStage;
+
+@property (strong, nonatomic) NSDictionary *branchParams;
+
+@property (strong, nonatomic) NSDictionary *branchOGTags;
+
+// ========== End Branch ==========
 @end
 
 /// -----------------------------------------
@@ -155,6 +175,90 @@ These can be custom items, or additional instances of the official items above.
  */
 + (instancetype)contentFromURL:(NSURL *)url;
 
+// ========== Branch ==========
+/**
+ Branch extensions to convenient constructors for links
+ */
+
+// All Branch Arguments: Tracking, Deep link params, Stage, and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+            branchTrackingTags:(NSArray *)branchTrackingTags
+                  branchParams:(NSDictionary *)branchParams
+                   branchStage:(NSString *)branchStage
+                 branchFeature:(NSString *)branchFeature;
+
+// Tracking tags
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags;
+
+// Tracking Tags, Deep link params
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchPrams;
+
+// Deep link params
++ (instancetype)contentFromURL:(NSURL *)url
+                            branchParams:(NSDictionary *)branchPrams;
+
+// Tracking Tags, Deep link params, Stage
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchPrams
+                             branchStage:(NSString *)branchStage;
+
+// Deep link params, Stage
++ (instancetype)contentFromURL:(NSURL *)url
+                            branchParams:(NSDictionary *)branchPrams
+                             branchStage:(NSString *)branchStage;
+
+// Tracking Tags, Stage
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                             branchStage:(NSString *)branchStage;
+
+// Stage
++ (instancetype)contentFromURL:(NSURL *)url
+                             branchStage:(NSString *)branchStage;
+
+// Tracking tags, Deep link params, and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchParams
+                           branchFeature:(NSString *)branchFeature;
+
+// Tracking tags, Stage, and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Deep link params, Stage and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                            branchParams:(NSDictionary *)branchParams
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Deep link params and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                            branchParams:(NSDictionary *)branchParams
+                           branchFeature:(NSString *)branchFeature;
+
+// Stage and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Tracking tags and Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                           branchFeature:(NSString *)branchFeature;
+
+// Feature
++ (instancetype)contentFromURL:(NSURL *)url
+                           branchFeature:(NSString *)branchFeature;
+
+// ========== End Branch ==========
+
 /**
  Convenient constructor for content drawn from microblog posts (like Twitter or App.net).
  */
@@ -163,12 +267,150 @@ These can be custom items, or additional instances of the official items above.
                             canonicalURL:(NSString *)canonicalURL
                                   images:(NSArray *)images;
 
+// ========== Branch ==========
+/**
+ Branch extensions to convenient constructors for microblog posts
+ */
+
+// All Branch Arguments: Tracking, Deep link params, Stage, and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchParams
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Tracking tags
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags;
+
+// Tracking Tags, Deep link params
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchPrams;
+
+// Deep link params
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                            branchParams:(NSDictionary *)branchPrams;
+
+// Tracking Tags, Deep link params, Stage
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchPrams
+                                branchStage:(NSString *)branchStage;
+
+// Deep link params, Stage
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                            branchParams:(NSDictionary *)branchPrams
+                             branchStage:(NSString *)branchStage;
+
+// Tracking Tags, Stage
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                             branchStage:(NSString *)branchStage;
+
+// Stage
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                             branchStage:(NSString *)branchStage;
+
+// Tracking tags, Deep link params, and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                            branchParams:(NSDictionary *)branchParams
+                           branchFeature:(NSString *)branchFeature;
+
+// Tracking tags, Stage, and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Deep link params, Stage and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                            branchParams:(NSDictionary *)branchParams
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Deep link params and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                            branchParams:(NSDictionary *)branchParams
+                           branchFeature:(NSString *)branchFeature;
+
+// Stage and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                             branchStage:(NSString *)branchStage
+                           branchFeature:(NSString *)branchFeature;
+
+// Tracking tags and Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                      branchTrackingTags:(NSArray *)branchTrackingTags
+                           branchFeature:(NSString *)branchFeature;
+
+// Feature
++ (instancetype)contentFromMicroblogPost:(NSString *)text
+                              authorName:(NSString *)authorName
+                            canonicalURL:(NSString *)canonicalURL
+                                  images:(NSArray *)images
+                           branchFeature:(NSString *)branchFeature;
+
+// ========== End Branch ==========
+
 /**
  Convenient constructor for sharing one or more images with a common caption.
  */
 + (instancetype)contentFromImages:(NSArray *)images
                           caption:(NSString *)caption;
 
+// ========== Branch ==========
+
+/**
+ Processes URLs in all Content Items and replaces with Branch URLs
+ */
+- (void)processURLsForBranch;
+
+// ========== Branch ==========
+
 @end