Updates for 0.12.6 release.

Author: ahmednawar

Branch-SDK/Branch-SDK/BNCConfig.h

@@ -9,7 +9,7 @@
 #ifndef Branch_SDK_Config_h
 #define Branch_SDK_Config_h
 
-#define SDK_VERSION             @"0.12.5"
+#define SDK_VERSION             @"0.12.6"
 
 #define BNC_PROD_ENV
 //#define BNC_STAGE_ENV

Branch-SDK/Branch-SDK/Branch.m

@@ -1311,7 +1311,7 @@ + (NSString *)bundleIdentifier {
 }
 
 + (NSString *)kitDisplayVersion {
-	return @"0.12.5";
+	return @"0.12.6";
 }
 
-@end
+@end

Branch.framework/Versions/A/Branch

@@ -11,11 +11,11 @@
 
 @class BranchUniversalObject, BranchLinkProperties;
 
-typedef void (^callbackWithParams) (NSDictionary *params, NSError *error);
-typedef void (^callbackWithUrl) (NSString *url, NSError *error);
-typedef void (^callbackWithStatus) (BOOL changed, NSError *error);
-typedef void (^callbackWithList) (NSArray *list, NSError *error);
-typedef void (^callbackWithUrlAndSpotlightIdentifier) (NSString *url, NSString *spotlightIdentifier, NSError *error);
-typedef void (^callbackWithBranchUniversalObject) (BranchUniversalObject *universalObject, BranchLinkProperties *linkProperties, NSError *error);
+typedef void (^callbackWithParams) (NSDictionary * _Nonnull params, NSError * _Nullable error);
+typedef void (^callbackWithUrl) (NSString * _Nonnull url, NSError * _Nullable error);
+typedef void (^callbackWithStatus) (BOOL changed, NSError * _Nullable error);
+typedef void (^callbackWithList) (NSArray * _Nullable list, NSError * _Nullable error);
+typedef void (^callbackWithUrlAndSpotlightIdentifier) (NSString * _Nullable url, NSString * _Nullable spotlightIdentifier, NSError * _Nullable error);
+typedef void (^callbackWithBranchUniversalObject) (BranchUniversalObject * _Nonnull universalObject, BranchLinkProperties * _Nonnull linkProperties, NSError * _Nullable error);
 
 #endif /* BNCCallbacks_h */

Branch.framework/Versions/A/Headers/BNCCallbacks.h

@@ -9,7 +9,7 @@
 #ifndef Branch_SDK_Config_h
 #define Branch_SDK_Config_h
 
-#define SDK_VERSION             @"0.12.5"
+#define SDK_VERSION             @"0.12.6"
 
 #define BNC_PROD_ENV
 //#define BNC_STAGE_ENV

Branch.framework/Versions/A/Headers/BNCConfig.h

@@ -23,6 +23,7 @@ typedef NS_ENUM(NSUInteger, BranchLinkType) {
 - (void)setupChannel:(NSString *)channel;
 - (void)setupFeature:(NSString *)feature;
 - (void)setupStage:(NSString *)stage;
+- (void)setupCampaign:(NSString *)campaign;
 - (void)setupParams:(NSDictionary *)params;
 - (void)setupMatchDuration:(NSUInteger)duration;
 - (void)setupIgnoreUAString:(NSString *)ignoreUAString;

Branch.framework/Versions/A/Headers/BNCLinkData.h

@@ -199,6 +199,20 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 + (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)params feature:(NSString *)feature stage:(NSString *)stage tags:(NSArray *)tags alias:(NSString *)alias;
 
+/**
+ Create a BranchActivityItemProvider which subclasses the `UIActivityItemProvider` This can be used for simple sharing via a `UIActivityViewController`.
+ 
+ Internally, this will create a short Branch Url that will be attached to the shared content.
+ 
+ @param params A dictionary to use while building up the Branch link.
+ @param feature The feature the generated link will be associated with.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param alias The alias for a link.
+ @warning This can fail if the alias is already taken.
+ */
++ (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)params feature:(NSString *)feature stage:(NSString *)stage campaign:(NSString *)campmaign tags:(NSArray *)tags alias:(NSString *)alias;
+
 /**
  Create a BranchActivityItemProvider which subclasses the `UIActivityItemProvider` This can be used for simple sharing via a `UIActivityViewController`.
  
@@ -407,8 +421,18 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 - (void)disableCookieBasedMatching;
 
 /**
- If you're using a version of the Facebook SDK that prevents application:didFinishLaunchingWithOptions: from returning
- YES/true when a Universal Link is clicked, you should enable this option.
+ TL;DR: If you're using a version of the Facebook SDK that prevents application:didFinishLaunchingWithOptions: from
+ returning YES/true when a Universal Link is clicked, you should enable this option.
+
+ Long explanation: in application:didFinishLaunchingWithOptions: you should choose one of the following:
+
+ 1. Always `return YES;`, and do *not* invoke `[[Branch getInstance] accountForFacebookSDKPreventingAppLaunch];`
+ 2. Allow the Facebook SDK to determine whether `application:didFinishLaunchingWithOptions:` returns `YES` or `NO`,
+    and invoke `[[Branch getInstance] accountForFacebookSDKPreventingAppLaunch];`
+
+ The reason for this second option is that the Facebook SDK will return `NO` if a Universal Link opens the app
+ but that UL is not a Facebook UL. Some developers prefer not to modify
+ `application:didFinishLaunchingWithOptions:` to always return `YES` and should use this method instead.
  */
 - (void)accountForFacebookSDKPreventingAppLaunch;
 
@@ -749,21 +773,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 - (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString;
 
 /**
- Get a short url with specified tags, params, channel, feature, and stage. The usage type will default to unlimited.
+ Get a short url with specified tags, params, channel, feature, stage and campaign. The usage type will default to unlimited.
  
  @param params Dictionary of parameters to include in the link.
  @param tags An array of tags to associate with this link, useful for tracking.
  @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
  @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
  @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
  @param alias The alias for a link.
  @param ignoreUAString The User Agent string to tell the server to ignore the next request from, to prevent it from treating a preview scrape as a link click.
  @param forceLinkCreation Whether we should create a link from the Branch Key even if initSession failed. Defaults to NO.
  @warning This method makes a synchronous url request.
  @warning This method is primarily intended to be an internal Branch method, used to work around a bug with SLComposeViewController
  @warning This can fail if the alias is already taken.
  */
-- (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString forceLinkCreation:(BOOL)forceLinkCreation;
+- (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:(NSString *)campaign andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString forceLinkCreation:(BOOL)forceLinkCreation;
 
 /**
  Get a short url with specified tags, params, channel, feature, stage, and type.
@@ -806,6 +831,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (NSString *)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andMatchDuration:(NSUInteger)duration;
 
+
+/**
+ Get a short url with specified params, channel, feature, stage, campaign and match duration. The usage type will default to unlimited.
+ 
+ @param params Dictionary of parameters to include in the link.
+ @param tags An array of tags to associate with this link, useful for tracking.
+ @param alias The alias for a link.
+ @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
+ @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param matchDuration How long to keep an unmatched link click in the Branch backend server's queue before discarding.
+ @warning This method makes a synchronous url request.
+ */
+- (NSString *)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:campaign andMatchDuration:(NSUInteger)duration;
+
 #pragma mark - Long Url generation
 
 ///--------------------------
@@ -1016,6 +1057,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andMatchDuration:(NSUInteger)duration andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCallback:(callbackWithUrl)callback;
 
+/**
+ Get a short url with the specified params, tags, channel, feature, stage, campaign and match duration. The usage type will default to unlimited.
+ 
+ @param params Dictionary of parameters to include in the link.
+ @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
+ @param tags An array of tags to associate with this link, useful for tracking.
+ @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param matchDuration How long to keep an unmatched link click in the Branch backend server's queue before discarding.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param callback Callback called with the url.
+ @param alias The alias for a link.
+ @warning This can fail if the alias is already taken.
+ */
+- (void)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andMatchDuration:(NSUInteger)duration andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:(NSString *)campaign andCallback:(callbackWithUrl)callback;
+
 - (void)getSpotlightUrlWithParams:(NSDictionary *)params callback:(callbackWithParams)callback;
 
 #pragma mark - Content Discovery methods

Branch.framework/Versions/A/Headers/Branch.h

@@ -21,6 +21,7 @@
 - (NSArray *)activityItemTagsForChannel:(NSString *)channel;
 - (NSString *)activityItemFeatureForChannel:(NSString *)channel;
 - (NSString *)activityItemStageForChannel:(NSString *)channel;
+- (NSString *)activityItemCampaignForChannel:(NSString *)channel;
 - (NSString *)activityItemAliasForChannel:(NSString *)channel;
 - (NSString *)activityItemOverrideChannelForChannel:(NSString *)channel;
 
@@ -29,6 +30,6 @@
 @interface BranchActivityItemProvider : UIActivityItemProvider
 
 - (id)initWithParams:(NSDictionary *)params andTags:(NSArray *)tags andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias  __attribute__((deprecated(("Use the delegate method instead"))));;
-- (id)initWithParams:(NSDictionary *)params tags:(NSArray *)tags feature:(NSString *)feature stage:(NSString *)stage alias:(NSString *)alias delegate:(id <BranchActivityItemProviderDelegate>)delegate;
+- (id)initWithParams:(NSDictionary *)params tags:(NSArray *)tags feature:(NSString *)feature stage:(NSString *)stage campaign:(NSString *)campaign alias:(NSString *)alias delegate:(id <BranchActivityItemProviderDelegate>)delegate;
 
 @end

Branch.framework/Versions/A/Headers/BranchActivityItemProvider.h

@@ -15,6 +15,7 @@
 @property (nonatomic, strong) NSString *alias;
 @property (nonatomic, strong) NSString *channel;
 @property (nonatomic, strong) NSString *stage;
+@property (nonatomic, strong) NSString *campaign;
 @property (nonatomic) NSUInteger matchDuration;
 @property (nonatomic, strong) NSDictionary *controlParams;
 

Branch.framework/Versions/A/Headers/BranchLinkProperties.h

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "Branch"
-  s.version          = "0.12.5"
+  s.version          = "0.12.6"
   s.summary          = "Create an HTTP URL for any piece of content in your app"
   s.description      = <<-DESC
 - Want the highest possible conversions on your sharing feature?
@@ -16,7 +16,6 @@ Use the Branch SDK (branch.io) to create and power the links that point back to
   s.license          = 'Proprietary'
   s.author           = { "Branch" => "[email protected]" }
   s.source           = { :git => "https://github.com/BranchMetrics/iOS-Deferred-Deep-Linking-SDK.git", :tag => s.version.to_s }
-  s.private_header_files = "Branch-SDK/Fabric/*.h"
   s.platform     = :ios, '6.0'
   s.requires_arc = true