Merge pull request #266 from BranchMetrics/BUO-returns-spotlight-ID

Dan Walkowski · Dan Walkowski · commit 2312d1b4cb8d · 2016-01-12T15:48:09.000-08:00
Spotlight IDs returned in indexing callbacks
diff --git a/Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.h b/Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.h
@@ -14,17 +14,34 @@
 - (NSString *)standardSpotlightIdentifierFromActivity:(NSUserActivity *)userActivity;
 
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords userInfo:(NSDictionary *)userInfo;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable thumbnailUrl:(NSURL *)thumbnailUrl userInfo:(NSDictionary *)userInfo;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords userInfo:(NSDictionary *)userInfo;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords userInfo:(NSDictionary *)userInfo callback:(callbackWithUrl)callback;
+
 - (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords userInfo:(NSDictionary *)userInfo expirationDate:(NSDate *)expirationDate callback:(callbackWithUrl)callback;
 
 
+
+/* This one has a different callback, which includes the spotlightIdentifier, and requires a different signature
+    It cannot be part of the stack of method signatures above, because of the different callback type.*/
+- (void)indexContentWithTitle:(NSString *)title description:(NSString *)description publiclyIndexable:(BOOL)publiclyIndexable type:(NSString *)type thumbnailUrl:(NSURL *)thumbnailUrl keywords:(NSSet *)keywords userInfo:(NSDictionary *)userInfo expirationDate:(NSDate *)expirationDate callback:(callbackWithUrl)callback spotlightCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback;
+
+
 @end
diff --git a/Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.m b/Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.m
diff --git a/Branch-SDK/Branch-SDK/Branch.h b/Branch-SDK/Branch-SDK/Branch.h
@@ -1331,6 +1331,22 @@ typedef NS_ENUM(NSUInteger, BranchPromoCodeUsageType) {
  */
 - (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSString *)description thumbnailUrl:(NSURL *)thumbnailUrl linkParams:(NSDictionary *)linkParams type:(NSString *)type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet *)keywords expirationDate:(NSDate *)expirationDate callback:(callbackWithUrl)callback;
 
+/**
+ Take the current screen and make it discoverable, adding it to Apple's Core Spotlight index. Will be public if specified. You can override the type as desired, using one of the types provided in MobileCoreServices.
+ 
+ @param title Title for the spotlight preview item.
+ @param description Description for the spotlight preview item.
+ @param thumbnailUrl Url to an image to be used for the thumnbail in spotlight.
+ @param linkParams Additional params to be added to the NSUserActivity. These will also be added to the Branch link.
+ @param publiclyIndexable Whether or not this item should be added to Apple's public search index.
+ @param type The type to use for the NSUserActivity, taken from the list of constants provided in the MobileCoreServices framework.
+ @param keywords A set of keywords to be used in Apple's search index.
+ @param expirationDate ExpirationDate after which this will not appear in Apple's search index.
+ @param callback Callback called with the Branch url this will fallback to.
+ @warning These functions are only usable on iOS 9 or above. Earlier versions will simply receive the callback with an error.
+ */
+- (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSString *)description thumbnailUrl:(NSURL *)thumbnailUrl linkParams:(NSDictionary *)linkParams type:(NSString *)type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet *)keywords expirationDate:(NSDate *)expirationDate spotlightCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback;
+
 #pragma mark - Referral Code methods
 
 ///-------------------------
diff --git a/Branch-SDK/Branch-SDK/Branch.m b/Branch-SDK/Branch-SDK/Branch.m
@@ -894,11 +894,14 @@ - (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSStri
 - (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSString *)description thumbnailUrl:(NSURL *)thumbnailUrl linkParams:(NSDictionary *)linkParams type:(NSString *)type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet *)keywords callback:(callbackWithUrl)callback {
     [self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams callback:callback];
 }
-
 - (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSString *)description thumbnailUrl:(NSURL *)thumbnailUrl linkParams:(NSDictionary *)linkParams type:(NSString *)type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet *)keywords expirationDate:(NSDate *)expirationDate callback:(callbackWithUrl)callback {
     [self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams expirationDate:expirationDate callback:callback];
 }
 
+//Use this with iOS 9+ only
+- (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSString *)description thumbnailUrl:(NSURL *)thumbnailUrl linkParams:(NSDictionary *)linkParams type:(NSString *)type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet *)keywords expirationDate:(NSDate *)expirationDate spotlightCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback {
+    [self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams expirationDate:expirationDate callback:nil spotlightCallback:spotlightCallback];
+}
 
 #pragma mark - Referral methods
 
diff --git a/Branch-SDK/Branch-SDK/BranchUniversalObject.h b/Branch-SDK/Branch-SDK/BranchUniversalObject.h
@@ -30,6 +30,7 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 @property (nonatomic) ContentIndexMode contentIndexMode;
 @property (nonatomic, strong) NSArray *keywords;
 @property (nonatomic, strong) NSDate *expirationDate;
+@property (nonatomic, strong) NSString *spotlightIdentifier;
 
 - (instancetype)initWithCanonicalIdentifier:(NSString *)canonicalIdentifier;
 - (instancetype)initWithTitle:(NSString *)title;
@@ -43,6 +44,7 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties andShareText:(NSString *)shareText fromViewController:(UIViewController *)viewController andCallback:(callback)callback;
 - (void)listOnSpotlight;
 - (void)listOnSpotlightWithCallback:(callbackWithUrl)callback;
+- (void)listOnSpotlightWithIdentifierCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback;
 
 // Convenience method for initSession methods that return BranchUniversalObject, but can be used safely by anyone.
 + (BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(NSDictionary *)dictionary;
diff --git a/Branch-SDK/Branch-SDK/BranchUniversalObject.m b/Branch-SDK/Branch-SDK/BranchUniversalObject.m
@@ -173,6 +173,7 @@ - (void)listOnSpotlightWithCallback:(callbackWithUrl)callback {
     else {
         publiclyIndexable = YES;
     }
+    
     [[Branch getInstance] createDiscoverableContentWithTitle:self.title
                                                  description:self.contentDescription
                                                 thumbnailUrl:[NSURL URLWithString:self.imageUrl]
@@ -184,6 +185,28 @@ - (void)listOnSpotlightWithCallback:(callbackWithUrl)callback {
                                                     callback:callback];
 }
 
+
+//This one uses a callback that returns the SpotlightIdentifier
+- (void)listOnSpotlightWithIdentifierCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback {
+    BOOL publiclyIndexable;
+    if (self.contentIndexMode == ContentIndexModePrivate) {
+        publiclyIndexable = NO;
+    }
+    else {
+        publiclyIndexable = YES;
+    }
+    
+    [[Branch getInstance] createDiscoverableContentWithTitle:self.title
+                                                 description:self.contentDescription
+                                                thumbnailUrl:[NSURL URLWithString:self.imageUrl]
+                                                  linkParams:self.metadata.copy
+                                                        type:self.type
+                                           publiclyIndexable:publiclyIndexable
+                                                    keywords:[NSSet setWithArray:self.keywords]
+                                              expirationDate:self.expirationDate
+                                           spotlightCallback:spotlightCallback];
+}
+
 + (BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(NSDictionary *)dictionary {
     BranchUniversalObject *universalObject = [[BranchUniversalObject alloc] init];
     
diff --git a/Branch-TestBed/Branch-TestBed/ViewController.m b/Branch-TestBed/Branch-TestBed/ViewController.m
@@ -66,8 +66,26 @@ - (IBAction)cmdShareLink:(id)sender {
 - (IBAction)cmdRegisterView:(id)sender {
     [self.branchUniversalObject registerView];
 }
+
 - (IBAction)cmdIndexSpotlight:(id)sender {
-    [self.branchUniversalObject listOnSpotlight];
+    [self.branchUniversalObject listOnSpotlightWithCallback:^(NSString *url, NSError *error) {
+        if (!error) {
+            NSLog(@"shortURL: %@", url);
+        } else {
+            NSLog(@"error: %@", error);
+        }
+    }];
+}
+
+//example using callbackWithURLandSpotlightIdentifier
+- (IBAction)cmdIndexSpotlightWithIdentifier:(id)sender {
+    [self.branchUniversalObject listOnSpotlightWithIdentifierCallback:^(NSString *url, NSString *spotlightIdentifier,  NSError *error) {
+        if (!error) {
+            NSLog(@"shortURL: %@   spotlight ID: %@", url, spotlightIdentifier);
+        } else {
+            NSLog(@"error: %@", error);
+        }
+    }];
 }
 
 - (IBAction)cmdRefreshRewards:(id)sender {

Original file line number	Diff line number	Diff line change
`@@ -894,11 +894,14 @@ - (void)createDiscoverableContentWithTitle:(NSString *)title description:(NSStri`
`894`	`894`	`- (void)createDiscoverableContentWithTitle:(NSString )title description:(NSString )description thumbnailUrl:(NSURL )thumbnailUrl linkParams:(NSDictionary )linkParams type:(NSString )type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet )keywords callback:(callbackWithUrl)callback {`
`895`	`895`	`[self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams callback:callback];`
`896`	`896`	`}`
`897`		`-`
`898`	`897`	`- (void)createDiscoverableContentWithTitle:(NSString )title description:(NSString )description thumbnailUrl:(NSURL )thumbnailUrl linkParams:(NSDictionary )linkParams type:(NSString )type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet )keywords expirationDate:(NSDate *)expirationDate callback:(callbackWithUrl)callback {`
`899`	`898`	`[self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams expirationDate:expirationDate callback:callback];`
`900`	`899`	`}`
`901`	`900`
	`901`	`+//Use this with iOS 9+ only`
	`902`	`+- (void)createDiscoverableContentWithTitle:(NSString )title description:(NSString )description thumbnailUrl:(NSURL )thumbnailUrl linkParams:(NSDictionary )linkParams type:(NSString )type publiclyIndexable:(BOOL)publiclyIndexable keywords:(NSSet )keywords expirationDate:(NSDate *)expirationDate spotlightCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback {`
	`903`	`+ [self.contentDiscoveryManager indexContentWithTitle:title description:description publiclyIndexable:publiclyIndexable type:type thumbnailUrl:thumbnailUrl keywords:keywords userInfo:linkParams expirationDate:expirationDate callback:nil spotlightCallback:spotlightCallback];`
	`904`	`+}`
`902`	`905`
`903`	`906`	`#pragma mark - Referral methods`
`904`	`907`