iOS Full Reference

let branch: Branch = Branch.getInstance()

Branch *branch = [Branch getInstance];

// Within the AppDelegate
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  let branch: Branch = Branch.getInstance()
  branch?.initSession(launchOptions: launchOptions, deepLinkHandler: { params, error in
    if error == nil {
        // Params are the deep linked params associated with the link that the user clicked
        print("params: %@", params.description)
    }
   })
  return true
}

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    // Pass URL to the "handle deep link" call
    let branchHandled = Branch.getInstance().application(
        application,
        open: url,
        options: options
    )
    if (!branchHandled) {
        // If not handled by Branch, do other deep link routing for the Facebook SDK, Pinterest SDK, etc
    }

    return true
}

func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    let handledByBranch = Branch.getInstance().continue(userActivity)

    return handledByBranch
}

// Within the AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    Branch *branch = [Branch getInstance];
    [branch initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary *params, NSError *error) {
    	// Route user based on params
    }];
    return YES;
}

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    BOOL branchHandled =
        [[Branch getInstance]
            application:application
                openURL:url
                options:options];
    if (!branchHandled) {
        // Do other deep link routing for the Facebook SDK, Pinterest SDK, etc.
    }
    return YES;
}

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *restorableObjects))restorationHandler {
    BOOL handledByBranch = [[Branch getInstance] continueUserActivity:userActivity];

    return handledByBranch;
}

// The following call would return `false`
Branch.getInstance().handleDeepLink("myapp://")

// The following call would return `true`
Branch.getInstance().handleDeepLink("myapp://open?link_click_id=12345")

// The following call would return `YES`
NSURL *URL = [NSURL URLWithString:@"myapp://open?link_click_id=12345"];
[[Branch getInstance] handleDeepLink:URL];

func application(application: UIApplication, continueUserActivity userActivity: NSUserActivity, restorationHandler: ([AnyObject]?) -> Void) -> Bool {
  Branch.getInstance().continueUserActivity(userActivity);
  return true
}

- (BOOL)application:(UIApplication *)application
continueUserActivity:(NSUserActivity *)userActivity
  restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *))restorationHandler {
    [[Branch getInstance] continueUserActivity:userActivity];
    return YES;
}

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
    Branch.getInstance().application(app, open: url, options:options)
    return true
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
    return [[Branch getInstance] application:app openURL:url options:options];
}

// NSDictionary userInfo = @{@"branch": @"https://bnc.lt/...", ... };
// NSDictionary userInfo = @{@"branch": @"https://app.link/...", ... };

Branch.getInstance().handlePushNotification(response.notification.request.content.userInfo)

// NSDictionary userInfo = @{@"branch": @"https://bnc.lt/...", ... };
// NSDictionary userInfo = @{@"branch": @"https://app.link/...", ... };

[[Branch getInstance] handlePushNotification:userInfo];

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  // Add `enableLogging` before `initSesssion` in AppDelegate
  Branch.getInstance().enableLogging()
  
	// Listener for Branch Deep Link data
	Branch.getInstance().initSession(launchOptions: launchOptions) { (params, error) in
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		print(params as? [String: AnyObject] ?? {})
	}
	return true
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	// Add `enableLogging` before `initSesssion` in AppDelegate
	[[Branch getInstance] enableLogging];

	// Listener for Branch Deep Link data
	[[Branch getInstance] initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary * _Nonnull params, NSError * _Nullable error) {
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		NSLog(@"%@", params);
	}];
	return YES;
}

Branch.setAPIURL("https://api3.branch.io")

[Branch setAPIURL:@"https://api3.branch.io"];

// Check your Xcode logs to make sure all the SDK Integration tests pass
// Make sure to comment out or remove validateSDKIntegration in your production build
Branch.getInstance().validateSDKIntegration()

// Check your Xcode logs to make sure all the SDK Integration tests pass
// Make sure to comment out or remove validateSDKIntegration in your production build
[[Branch getInstance] validateSDKIntegration];

Branch.getInstance().addAllowedScheme("https")

[[Branch getInstance] addAllowedScheme:@"https"];

var allowedSchemes = ["http", "https", "myapp"]
Branch.getInstance().setAllowedSchemes(allowedSchemes)

[[Branch getInstance] addAllowedScheme:@[@"http", @"https", @"myapp"]];

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
	// The `checkPasteboardOnInstall` call must be made before `initSesssion`
	Branch.getInstance().checkPasteboardOnInstall()

	// Listener for Branch Deep Link data
	Branch.getInstance().initSession(launchOptions: launchOptions) { (params, error) in
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		print(params as? [String: AnyObject] ?? {})
	}
  
	return true
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	// The `checkPasteboardOnInstall` call must be made before `initSesssion`
	[[Branch getInstance] checkPasteboardOnInstall];

	// Listener for Branch Deep Link data
	[[Branch getInstance] initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary * _Nonnull params, NSError * _Nullable error) {
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		NSLog(@"%@", params);
	}];
  
	return YES;
}

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
	// The `checkPasteboardOnInstall` call must be made before `initSesssion`
	Branch.getInstance().checkPasteboardOnInstall()
  
	// Check if pasteboard toast will show for end user
	if Branch.getInstance().willShowPasteboardToast(){
		// You can give the user information about what just occurred here
	}
  
	// Listener for Branch Deep Link data
	Branch.getInstance().initSession(launchOptions: launchOptions) { (params, error) in
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		print(params as? [String: AnyObject] ?? {})
	}
	return true
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	// The `checkPasteboardOnInstall` call must be made before `initSessionWithLaunchOptions`
	Branch.getInstance().checkPasteboardOnInstall()
  
	// Check if pasteboard toast will show for end user
	if ([[Branch getInstance] willShowPasteboardToast]) {
		// You can give the user information about what just occurred here    
	}

	// Listener for Branch Deep Link data
	[[Branch getInstance] initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary * _Nonnull params, NSError * _Nullable error) {
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		NSLog(@"%@", params);
	}];
	return YES;
}

// Within the AppDelegate
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    
    // The `setAppClipAppGroup()` call must be made before `initSession()`
    Branch.getInstance().setAppClipAppGroup("group.io.branch")
    BranchScene.shared().initSession(launchOptions: launchOptions) { (params, error, scene) in
        if let dict = params {
            
            if Monster.shared.waitingForData {
                let name = (dict["monster_name"] as? String) ?? "Branchster"
                Monster.shared.update(name: name)
            }
        }
    }
    
    return true
}

// Within the AppDelegate

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    Branch *branch = [Branch getInstance];
    
    // The `setAppClipAppGroup()` call must be made before `initSessionWithLaunchOptions()`
    [branch setAppClipAppGroup:@"group.io.branch"];

    [branch initSessionWithLaunchOptions:launchOptions
        andRegisterDeepLinkHandlerUsingBranchUniversalObject:
            ^ (BranchUniversalObject *BUO, BranchLinkProperties *linkProperties, NSError *error) {

    }];

		return YES;
}

if #available(iOS 14.0, *)  {
  // Check that `trackingAuthorizationStatus` is `notDetermined`, otherwise prompt will not display
	if ATTrackingManager.trackingAuthorizationStatus == .notDetermined {
		ATTrackingManager.requestTrackingAuthorization { (status) in
			// `handleATTAuthorizationStatus()` should be called from the callback of `requestTrackingAuthorization()`
			Branch.getInstance().handleATTAuthorizationStatus(status.rawValue)
		}
	}
}

if (@available(iOS 14.0, *)) {
  // Check that `trackingAuthorizationStatus` is `notDetermined`, otherwise prompt will not display
	if (ATTrackingManager.trackingAuthorizationStatus == ATTrackingManagerAuthorizationStatusNotDetermined) {
		[ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
      // `handleATTAuthorizationStatus()` should be called from the callback of `requestTrackingAuthorization()`
			[[Branch getInstance] handleATTAuthorizationStatus:status];
		}];
	}
}

Branch.getInstance().addFacebookPartnerParameter(withName: "ph", value: "0000xxxx")

// Call `initSession()` after `addFacebookPartnerParameter()`

[[Branch getInstance] addFacebookPartnerParameterWithName:@"ph" value:@"0000xxxx"];

// Call `initSession()` after `addFacebookPartnerParameterWithName()`

Branch.getInstance().addSnapPartnerParameter(withName: "ph", value: "0000xxxx")

// Call `initSession()` after `addSnapPartnerParameter()`

[[Branch getInstance] addSnapPartnerParameterWithName:@"ph" value:@"0000xxxx"];

// Call `initSession()` after `addSnapPartnerParameterWithName()`

Branch.getInstance().clearPartnerParameters()

[[Branch getInstance] clearPartnerParameters];

Branch.getInstance().setRetryInterval(10.0)

[[Branch getInstance] setRetryInterval:10.0];

Branch.getInstance().setMaxRetries(3)

[[Branch getInstance] setMaxRetries:3];

Branch.getInstance().setNetworkTimeout(10.0)

[[Branch getInstance] setNetworkTimeout:10.0];

Branch.getInstance().disableAdNetworkCallouts(true)

[[Branch getInstance] disableCallouts:YES];

Branch.getInstance().isBranchLink("https://example.app.link/fzmLEhobLD?$custom_data=123&hello=world")

[[Branch getInstance] isBranchLink:@"https://example.app.link/fzmLEhobLD?$custom_data=123&hello=world"];

// Inside the `didFinishLaunchingWithOptions` method
// Replace <analytics_id> with your Data Integration Partner's key
Branch.getInstance().setRequestMetadataKey("<analytics_id>", "<value>")

// Inside the `didFinishLaunchingWithOptions` method
// Replace <analytics_id> with your Data Integration Partner's key
[[Branch getInstance] setRequestMetadataKey:@"<analytics_id>" value: @"<value>"];

// Inside the `didFinishLaunchingWithOptions` method
Branch.getInstance.setRequestMetadataKey("$braze_install_id", braze.deviceId)

// Inside the `didFinishLaunchingWithOptions` method
[[Branch getInstance] setRequestMetadataKey:@"$braze_install_id" value: braze.deviceId];

// Call takes place at the SDK level
Branch.setTrackingDisabled(true)

// Call takes place at the SDK level
[Branch setTrackingDisabled:YES];

func trackingStatus() -> Bool {
  // Call takes place at the SDK level
  return Branch.trackingDisabled()
}

// Call takes place at the SDK level
[Branch trackingDisabled];

Branch.setReferrerGbraidValidityWindow(10.0)

[Branch setReferrerGbraidValidityWindow:10.0]

// Example for an EEA resident who has denied both ad personalization and data usage consent
Branch.getInstance().setDMAParamsForEEA(true,false,false)

// Example for an EEA resident who has denied both ad personalization and data usage consent
[[Branch getInstance]
	setDMAParamsForEEA:YES
	adPersonalizationConsent:NO
	adUserDataUsageConsent:NO];

// Example for an EEA resident who has consented to ad personalization but denied data usage consent
Branch.getInstance().setDMAParamsForEEA(true,true,false)

// Example for an EEA resident who has consented to ad personalization but denied data usage consent
[[Branch getInstance]
	setDMAParamsForEEA:YES
	adPersonalizationConsent:YES
	adUserDataUsageConsent:NO];

// Example for an EEA resident who has denied ad personalization but granted data usage consent
Branch.getInstance().setDMAParamsForEEA(true,false,true)

// Example for an EEA resident who has denied ad personalization but granted data usage consent
[[Branch getInstance]
	setDMAParamsForEEA:YES
	adPersonalizationConsent:NO
	adUserDataUsageConsent:YES];

Branch.getInstance.getFirstReferringBranchUniversalObject()

const char *_getFirstReferringBranchUniversalObject() {
	BranchUniversalObject* universalObject = [[Branch getInstance] getFirstReferringBranchUniversalObject];
	return jsonCStringFromDictionary(dictFromBranchUniversalObject(universalObject));
}

Branch.getInstance.getFirstReferringBranchLinkProperties()

[[Branch getInstance] getFirstReferringBranchLinkProperties];

// In AppDelegate file, inside `didFinishLaunchingWithOptions()` method

// Listener for Branch Deep Link data
Branch.getInstance().initSession(launchOptions: launchOptions) { params, error in
  print(params as? [String: AnyObject] ?? {})
}

// Get first referring params for Deep Link
let installParams = Branch.getInstance().getFirstReferringParams()

// In AppDelegate file, inside `didFinishLaunchingWithOptions()` method

// Listener for Branch Deep Link data
[[Branch getInstance] initSessionWithLaunchOptions:launchOptions
                        andRegisterDeepLinkHandler:^(NSDictionary * _Nullable params,
                                                     NSError * _Nullable error) {
    if (!error) {
        //Referring params
        NSLog(@"Referring link params %@",params);
    }
}];

// Get first referring params for Deep Link
NSDictionary *installParams =  [[Branch getInstance] getFirstReferringParams];

Branch.getInstance.getLatestReferringBranchUniversalObject()

[[Branch getInstance] getLatestReferringBranchUniversalObject];

Branch.getInstance.getLatestReferringBranchLinkProperties()

[[Branch getInstance] getLatestReferringBranchLinkProperties];

// In AppDelegate file, inside `didFinishLaunchingWithOptions()` method

// Listener for Branch Deep Link data
Branch.getInstance().initSession(launchOptions: launchOptions) { params, error in
  print(params as? [String: AnyObject] ?? {})
}

// Get latest referring params for Deep Link
// Warning: This method may return results from a previous referral
let sessionParams = Branch.getInstance().getLatestReferringParams()

// In AppDelegate file, inside `didFinishLaunchingWithOptions()` method

// Listener for Branch Deep Link data
[[Branch getInstance] initSessionWithLaunchOptions:launchOptions
                        andRegisterDeepLinkHandler:^(NSDictionary * _Nullable params,
                                                     NSError * _Nullable error) {
    if (!error) {
        //Referring params
        NSLog(@"Referring link params %@",params);
    }
}];

// Get latest referring params for Deep Link
// Warning: This method may return results from a previous referral
NSDictionary *sessionParams = [[Branch getInstance] getLatestReferringParams];

// Warning: This method blocks the calling thread until the latest results are available
Branch.getInstance.getLatestReferringParamsSynchronous()

// Warning: This method may block the current thread until the latest results are available
[[Branch getInstance] getLatestReferringParamsSynchronous];

Branch.getInstance.resetUserSession()

[[Branch getInstance] resetUserSession];

// Warning: only invoke `isUserIdentified()` after `initSession()` completes
Branch.getInstance.isUserIdentified()

// Warning: only invoke `isUserIdentified() after `initSession()` completes
[[Branch getInstance] isUserIdentified];

// Login
Branch.getInstance().setIdentity("your_user_id")

// Logout
Branch.getInstance().logout()

//Login
Branch *branch = [Branch getInstance];
[branch setIdentity:@"test_user" withCallback:^(NSDictionary *params, NSError *error) {
	NSLog(@"callback in setIdentity %@", params);
}];

// Logout
[[Branch getInstance] logout]; // Or replace with .logoutWithCallback() to customize further

Branch.getInstance().logout()

[[Branch getInstance] logout];

let branch = Branch.getInstance()
branch.logoutWithCallback { (changed, error) in
	if (error != nil || !changed) {
		print(String(format: "Logout failed: %@", error!))
} else {
		print("Logout succeeded")
	}
}

Branch *branch = [Branch getInstance];
[branch logoutWithCallback:^(BOOL changed, NSError *error) {
	if (error || !changed) {
		NSLog(@"Logout failed: %@", error);
  } else {
    NSLog(@"Logout succeeded");
  }
}];

Branch.getInstance().getShortURL()

[[Branch getInstance] getShortURL];

// For all variations of `getShortURLWithParams()` the usage type will default to unlimited

let params: [String: Any] = [
    "key1": "value1",
    "key2": "value2"
]
let shortURL = Branch.getInstance().getShortURL(withParams: params)

// For all variations of `getShortURLWithParams()` the usage type will default to unlimited

NSDictionary *params = @{
    @"key1": @"value1",
    @"key2": @"value2"
};
NSString *shortURL = [[Branch getInstance] getShortURLWithParams:params];

// For all variations of `getShortURLWithParams()` the usage type will default to unlimited

let params: [String: Any] = [
    "key1": "value1",
    "key2": "value2"
]

let shortURL = Branch.getInstance().getShortURL(withParams:params andTags:["one", "two", "three"])

// For all variations of `getShortURLWithParams()` the usage type will default to unlimited

NSDictionary *params = @{
    @"key1": @"value1",
    @"key2": @"value2"
};

NSString *shortURL = [[Branch getInstance] getShortURLWithParams:params andTags:@["one", "two", "three"]];

// For all variations of `getLongURLWithParams()` the usage type will default to unlimited

let params: [String: Any] = [
    "key1": "value1",
    "key2": "value2"
]
let longUrl = Branch.getInstance().getLongURL(withParams: params, andChannel: "channel", andTags: ["tag1"], andFeature: "feature", andStage: "stage", andAlias: "testingLinkAlias123")

// For all variations of `getLongURLWithParams()` the usage type will default to unlimited

NSDictionary *params = @{
    @"key1": @"value1",
    @"key2": @"value2"
};
NSString *longUrl = [[Branch getInstance] getLongURLWithParams:params andChannel:@"channel" andTags:@[@"tag1"] andFeature:@"feature" andStage:@"stage" andAlias:@"testingLinkAlias123"];

// The usage type of `getLongAppLinkURLWithParams()` will default to unlimited

let params: [String: Any] = [
    "key1": "value1",
    "key2": "value2"
]

let longAppUrl = Branch.getInstance().getLongAppLinkURL(withParams: params, andChannel: "channel", andTags: ["tag1"], andFeature: "feature", andStage: "stage", andAlias: "testingLinkAlias123")

// The usage type of `getLongAppLinkURLWithParams()` will default to unlimited

NSDictionary *params = @{
    @"key1": @"value1",
    @"key2": @"value2"
};

NSString *longAppUrl = [[Branch getInstance] getLongAppLinkURLWithParams:params andChannel:@"channel" andTags:@[@"tag1"] andFeature:@"feature" andStage:@"stage" andAlias:@"testingLinkAlias123"];

// The usage type of `getShortURLWithCallback()` will default to unlimited

Branch.getInstance().getShortURLWithCallback { (url, error) in
	print("Generated short URL: \(url)")
}

// The usage type of `getShortURLWithCallback()` will default to unlimited

NSDictionary *params = @{
	@"key1": @"value1",
	@"key2": @"value2"
};
  
[[Branch getInstance] getShortURLWithCallback:^(NSString * _Nullable url, NSError * _Nullable error) {
    NSLog(@"Generated short URL: %@", url);
}];

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay
// The usage type of `getShortURLWithParams()` will default to unlimited

let linkProperties: BranchLinkProperties = BranchLinkProperties()
linkProperties.channel = "facebook"
linkProperties.feature = "sharing"
linkProperties.campaign = "content 123 launch"
linkProperties.stage = "new user"
linkProperties.alias = "myapp.com/customalias"
linkProperties.matchDuration = 0

func generateShortUrl(params: [AnyHashable : Any], linkProperties: BranchLinkProperties, completion: @escaping (String?, Error?)->(Void)) -> Void {
	Branch.getInstance().getShortUrl(withParams: params, andChannel: linkProperties.channel, andFeature: linkProperties.feature, andStage: linkProperties.stage, andAlias: linkProperties.alias) { (url, error) in
		if (error == nil) {
			completion(url, nil)
		} else {
			completion(nil, error)
		}
	}
}

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay
// The usage type of `getShortURLWithParams()` will default to unlimited

Branch *branch = [Branch getInstance];
[branch getShortURLWithParams:nil andChannel:@"facebook" andFeature:nil andCallback:^(NSString *url, NSError *error) {
	// Do stuff with URL here
}];

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay
// The usage type of `getShortURLWithParams()` will default to unlimited

let linkProperties: BranchLinkProperties = BranchLinkProperties()
linkProperties.channel = "facebook"
linkProperties.feature = "sharing"
linkProperties.campaign = "content 123 launch"
linkProperties.stage = "new user"
linkProperties.tags = ["one", "two", "three"]
linkProperties.alias = "myapp.com/customalias"
linkProperties.matchDuration = 0

func generateShortUrl(params: [AnyHashable : Any], linkProperties: BranchLinkProperties, completion: @escaping (String?, Error?)->(Void)) -> Void {
	Branch.getInstance().getShortUrl(withParams: params, andTags: linkProperties.tags, andAlias: linkProperties.alias, andMatchDuration: linkProperties.matchDuration, andChannel: linkProperties.channel, andFeature: linkProperties.feature, andStage: linkProperties.stage, andCampaign: linkProperties.campaign) { (url, error) in
		if (error == nil) {
			completion(url, nil)
		} else {
			completion(nil, error)
		}
	}
}

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay
// The usage type of `getShortURLWithParams()` will default to unlimited

BranchLinkProperties *linkProperties = [[BranchLinkProperties alloc] init];
linkProperties.feature = @"share";
linkProperties.channel = @"facebook";
linkProperties.stage = @"new user";
linkProperties.tags = @["one", "two", "three"]

Branch *branch = [Branch getInstance];
[branch getShortURLWithParams:nil andTags:linkProperties.tags andChannel:linkProperties.channel andFeature:linkProperties.feature andStage:linkProperties.stage andCallback:^(NSString *url, NSError *error) {
	// Do stuff with URL here
}];

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay

let params: [String: Any] = [
    "key1": "value1",
    "key2": "value2"
]

Branch.getInstance().getSpotlightUrl(withParams: params) { (returnedParams, error) in
	if let url = returnedParams?["url"] as? String {
		print("Got spotlight URL with params: \(url)")
	}
}

// Warning: This method should only be invoked after `initSession()` completes, either within the callback or after a delay

NSDictionary *params = @{
    @"key1": @"value1",
    @"key2": @"value2"
};

[[Branch getInstance] getSpotlightUrlWithParams:params callback:^(NSDictionary * _Nullable returnedParams, NSError * _Nullable error) {
	NSLog(@"Got spotlight URL with params: %@", returnedParams[@"url"]);
}];

Branch.getInstance().createDiscoverableContent(withTitle: "Discover Branch", description: "Content Description")

[[Branch getInstance] createDiscoverableContentWithTitle:self.title
description:self.contentDescription
thumbnailUrl:[NSURL URLWithString:self.imageUrl]
canonicalId:self.canonicalIdentifier
linkParams:metadataAndProperties.copy
type:self.type
publiclyIndexable:publiclyIndexable
keywords:[NSSet setWithArray:self.keywords]
expirationDate:self.expirationDate
spotlightCallback:spotlightCallback];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

Branch.getInstance().indexOnSpotlight(with: buo, linkProperties: lp) { (universalObject, url, error) in
	print("Indexed Branch Universal Object instance on Spotlight.")
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [[BranchLinkProperties alloc] init];

[[Branch getInstance] indexOnSpotlightWithBranchUniversalObject:buo linkProperties:lp completion:^(BranchUniversalObject * _Nonnull universalObject, NSString * _Nonnull url, NSError * _Nonnull error) {
	NSLog(@"Indexed Branch Universal Object instance on Spotlight.");
}];

let buoArray: [BranchUniversalObject] = [
  BranchUniversalObject(canonicalIdentifier: "item/12345"),
  BranchUniversalObject(canonicalIdentifier: "item/6789")
]

Branch.getInstance().indexOnSpotlight(usingSearchableItems: buoArray) { (universalObjects, error) in
	print("Indexed Branch Universal Object instance on Spotlight.")
}

NSArray<BranchUniversalObject *> *buoArray = @[
  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"],
  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/6789"]
];

[[Branch getInstance] indexOnSpotlightUsingSearchableItems:buoArray completion:^(NSArray<BranchUniversalObject *> * _Nonnull universalObjects, NSError * _Nonnull error) {
	NSLog(@"Indexed Branch Universal Object instance on Spotlight.");
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

Branch.getInstance().removeSearchableItem(with: buo) { (universalObject, error) in
	print("Removed Branch Universal Object instance from Spotlight.")                                                                          
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

[[Branch getInstance] removeSearchableItemWithBranchUniversalObject:buo completion:^(BranchUniversalObject * _Nonnull universalObject, NSError * _Nonnull error) {
	NSLog(@"Removed Branch Universal Object instance on Spotlight.");
}];

let buoArray: [BranchUniversalObject] = [
  BranchUniversalObject(canonicalIdentifier: "item/12345"),
  BranchUniversalObject(canonicalIdentifier: "item/6789")
]

Branch.getInstance().removeSearchableItems(with: buoArray) { (universalObjects, error) in
	print("Removed Branch Universal Object instances on Spotlight.")
}

NSArray<BranchUniversalObject *> *buoArray = @[
  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"],
  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/6789"]
];

[[Branch getInstance] removeSearchableItemsWithBranchUniversalObject:buoArray completion:^(NSArray<BranchUniversalObject *> * _Nonnull universalObjects, NSError * _Nonnull error) {
	NSLog(@"Indexed Branch Universal Object instance on Spotlight.");
}];

Branch.getInstance().removeAllPrivateContentFromSpotLight { (error) in
    print("Removed all private content from Spotlight.")
}

[[Branch getInstance] removeAllPrivateContentFromSpotLightWithCallback:^(NSError * _Nullable error) {
	NSLog(@"Removed all private content from Spotlight.");
}];

// Inside the ViewController
override func paste(itemProviders: [NSItemProvider]) {
	if #available(iOS 16.0, *) {
		Branch.getInstance().passPaste(itemProviders)
	} else {
		// Fallback on earlier versions
	}
}

// Inside the ViewController
if (@available(iOS 16.0, *)) {
	[[Branch getInstance] passPasteItemProviders:itemProviders]
}

Branch.getInstance().setLogInAppPurchasesAsEventsEnabled(true)

[[Branch getInstance] setLogInAppPurchasesAsEventsEnabled:YES];

Branch.getInstance().logInAppPurchasesBranchEventsEnabled()

[[Branch getInstance] logInAppPurchasesBranchEventsEnabled];

// This method should only be invoked after `initSession()`
// If it's invoked before, Branch will silently initialize the SDK before the callback has been set

let event = BranchEvent(standardEvent: .addToCart)
event.logEvent { (success, error) in
    print("Event logged: \(success)")
}

// This method should only be invoked after `initSession()`
// If it's invoked before, Branch will silently initialize the SDK before the callback has been set

// Example 1
event = [BranchEvent standardEvent:BranchStandardEventInitiatePurchase];
[event logEventWithCompletion:^(BOOL success, NSError * _Nullable error) {
	if (success) {
		[self showAlert:@"Succesfully logged commerce event" withDescription:@""];
	} else {
		[self showAlert:@"Error sending commerce event:" withDescription:error.description];
	}
}];

// Example 2
BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventAddToCart];
[event logEventWithCompletion:^(BOOL success, NSError * _Nullable error) {
    NSLog(@"Event logged: %@", @(success));
}];

// This method should only be invoked after `initSession()`
// If it's invoked before, Branch will silently initialize the SDK before the callback has been set

// Create a Branch Event (this example uses the `Purchase` event)
let event = BranchEvent.standardEvent(.purchase)

// Add a populated `BranchUniversalObject` to the event
let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
event.contentItems     = [ buo ]

// Add additional event data
event.alias = "my custom alias"
event.transactionID = "12344555"
event.eventDescription = "event_description"
event.searchQuery = "item 123"
event.customData = [
    "Custom_Event_Property_Key1": "Custom_Event_Property_val1",
    "Custom_Event_Property_Key2": "Custom_Event_Property_val2"
]

// Log the event
event.logEvent()

// This method should only be invoked after `initSession()`
// If it is invoked before, Branch will silently initialize the SDK before the callback has been set

// Create a Branch Event (this example uses the `BranchStandardEventAddToCart` event)
BranchEvent *event     = [BranchEvent standardEvent:BranchStandardEventAddToCart];

// Add a populated `BranchUniversalObject` to the event
BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
event.contentItems     = (id) @[ buo ];

// Add additional event data
event.alias = @"my custom alias";
event.transactionID = @"12344555";
event.eventDescription = @"event_description";
event.searchQuery = @"item 123";
event.customData = (NSMutableDictionary*) @{
    @"Custom_Event_Property_Key1": @"Custom_Event_Property_val1",
    @"Custom_Event_Property_Key2": @"Custom_Event_Property_val2"
};

// Log the event
[event logEvent];

let event = BranchEvent(name: "PURCHASE")
event.logEvent(with: transaction as! SKPaymentTransaction)

BranchEvent *event = [[BranchEvent alloc] initWithName:@"eventName"];
[event logEventWithTransaction:(SKPaymentTransaction *)transaction];

let lp = BranchLinkProperties()
lp.addControlParam("$desktop_url", withValue: "http://example.com/desktop")
lp.addControlParam("$ios_url", withValue: "http://example.com/ios")
lp.addControlParam("$ipad_url", withValue: "http://example.com/ios")
lp.addControlParam("$android_url", withValue: "http://example.com/android")
lp.addControlParam("$match_duration", withValue: "2000")
lp.addControlParam("custom_data", withValue: "yes")
lp.addControlParam("look_at", withValue: "this")
lp.addControlParam("nav_to", withValue: "over here")
lp.addControlParam("random", withValue: UUID.init().uuidString)

BranchLinkProperties *lp = [[BranchLinkProperties alloc] init];
lp.feature = @"facebook";
lp.channel = @"sharing";
lp.campaign = @"content 123 launch";
lp.stage = @"new user";
lp.tags = @[@"one", @"two", @"three"];

[lp addControlParam:@"$desktop_url" withValue: @"http://example.com/desktop"];
[lp addControlParam:@"$ios_url" withValue: @"http://example.com/ios"];
[lp addControlParam:@"$ipad_url" withValue: @"http://example.com/ios"];
[lp addControlParam:@"$android_url" withValue: @"http://example.com/android"];
[lp addControlParam:@"$match_duration" withValue: @"2000"];

[lp addControlParam:@"custom_data" withValue: @"yes"];
[lp addControlParam:@"look_at" withValue: @"this"];
[lp addControlParam:@"nav_to" withValue: @"over here"];
[lp addControlParam:@"random" withValue: [[NSUUID UUID] UUIDString]];

let lp = BranchLinkProperties.getBranchLinkProperties(from: lpDictionary)

// Example 1
NSDictionary *params = [self getFirstReferringParams];
if ([[params objectForKey:BRANCH_INIT_KEY_CLICKED_BRANCH_LINK] isEqual:@1]) {
	return [BranchLinkProperties getBranchLinkPropertiesFromDictionary:params];
}

// Example 2
BranchLinkProperties *lp = [BranchLinkProperties getBranchLinkPropertiesFromDictionary:lpDictionary];

// Inside the ViewController
if #available(iOS 16.0, *) {
	// Setup `UIPasteControl` configuration
	let pcConfig = UIPasteControl.Configuration()
	pcConfig.baseBackgroundColor = UIColor.blue
	pcConfig.displayMode = UIPasteControl.DisplayMode.iconOnly

	// Create frame and button
	let frameDimension = CGRect(x: 0, y: 0, width: 40, height: 40)
	let bc = BranchPasteControl(frame: frameDimension, andConfiguration: pcConfig)

	// Add `BranchPasteControl` button to superview
	view.addSubview(bc)
}

// Inside the ViewController
if (@available(iOS 16.0, *)) {
  // Setup `UIPasteControl` configuration
  UIPasteControlConfiguration *pcConfig = [[UIPasteControlConfiguration alloc] init];
  pcConfig.baseBackgroundColor = UIColor.blueColor;
  pcConfig.displayMode = UIPasteControlDisplayModeIconOnly;

  // Create frame and button
  CGRect frameDimension = CGRectMake(0, 0, 120.0, 30.0);
  BranchPasteControl *bc = [[BranchPasteControl alloc] initWithFrame:frameDimension AndConfiguration:pcConfig];

  // Add `BranchPasteControl` button to superview
  [view addSubview:bc];
}

let qrCode = BranchQRCode()
qrCode.codeColor = UIColor.white
qrCode.backgroundColor = UIColor.blue
qrCode.centerLogo = "https://cdn.branch.io/branch-assets/1598575682753-og_image.png"
qrCode.width = 1024
qrCode.margin = 1
qrCode.imageFormat = .JPEG

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

// Display the QR code directly in a share sheet
qrCode.showShareSheetWithQRCode(from: self, anchor: nil, universalObject: buo, linkProperties: lp) { error in
    // Showing a share sheet with the QR code
}

BranchQRCode *qrCode = [BranchQRCode new];
qrCode.codeColor = [[UIColor new] initWithRed:0.1 green:0.8392 blue:0.8667 alpha:1.0];
qrCode.backgroundColor = [UIColor whiteColor];
qrCode.width = @700;
qrCode.margin = @1;
qrCode.centerLogo = @"https://cdn.branch.io/branch-assets/1598575682753-og_image.png";
qrCode.imageFormat = BranchQRCodeImageFormatPNG;
    
BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

// Display the QR code directly in a share sheet
[qrCode showShareSheetWithQRCodeFromViewController:self anchor:nil universalObject:buo linkProperties:lp completion:^(NSError * _Nullable error) {
    // Showing a share sheet with the QR code
}];

let qrCode = BranchQRCode()
qrCode.codeColor = UIColor.white
qrCode.backgroundColor = UIColor.blue
qrCode.centerLogo = "https://cdn.branch.io/branch-assets/1598575682753-og_image.png"
qrCode.width = 1024
qrCode.margin = 1
qrCode.imageFormat = .JPEG

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

qrCode.getAsData(buo, linkProperties: lp) { qrCodeImage, error in
    // Do something with your QR code here...
}

BranchQRCode *qrCode = [BranchQRCode new];
qrCode.codeColor = [[UIColor new] initWithRed:0.1 green:0.8392 blue:0.8667 alpha:1.0];
qrCode.backgroundColor = [UIColor whiteColor];
qrCode.width = @700;
qrCode.margin = @1;
qrCode.centerLogo = @"https://cdn.branch.io/branch-assets/1598575682753-og_image.png";
qrCode.imageFormat = BranchQRCodeImageFormatPNG;
    
BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

[qrCode getQRCodeAsData:buo linkProperties:lp completion:^(UIImage * _Nonnull qrCode, NSError * _Nonnull error) {
    // Do something with the QR code here...
}];

let qrCode = BranchQRCode()
qrCode.codeColor = UIColor.white
qrCode.backgroundColor = UIColor.blue
qrCode.centerLogo = "https://cdn.branch.io/branch-assets/1598575682753-og_image.png"
qrCode.width = 1024
qrCode.margin = 1
qrCode.imageFormat = .JPEG

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

qrCode.getAsImage(buo, linkProperties: lp) { qrCodeImage, error in
    // Do something with your QR code here...
}

BranchQRCode *qrCode = [BranchQRCode new];
qrCode.codeColor = [[UIColor new] initWithRed:0.1 green:0.8392 blue:0.8667 alpha:1.0];
qrCode.backgroundColor = [UIColor whiteColor];
qrCode.width = @700;
qrCode.margin = @1;
qrCode.centerLogo = @"https://cdn.branch.io/branch-assets/1598575682753-og_image.png";
qrCode.imageFormat = BranchQRCodeImageFormatPNG;
    
BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

[qrCode getQRCodeAsImage:buo linkProperties:lp completion:^(UIImage * _Nonnull qrCode, NSError * _Nonnull error) {
    // Do something with the QR code here...
}];

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

	func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
		// Override point for customization after application launch

		BranchScene.shared().initSession(launchOptions: launchOptions, registerDeepLinkHandler: { (params, error, scene) in  
                                                                                             
		})
		return true
	}
}

@interface AppDelegate ()

@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    [[BranchScene shared] initSessionWithLaunchOptions:launchOptions registerDeepLinkHandler:^(NSDictionary * _Nullable params, NSError * _Nullable error, UIScene * _Nullable scene) {
        
    }];

    return YES;
}

class SceneDelegate: UIResponder, UIWindowSceneDelegate {
	var window: UIWindow?
  
	// Use `scene` to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`
	// If using a storyboard, the `window` property will automatically be initialized and attached to the scene
	// This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead)
	func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
		guard let _ = (scene as? UIWindowScene) else { return }
    
		// Workaround for SceneDelegate `continueUserActivity` not getting called on cold start:
		if let userActivity = connectionOptions.userActivities.first {
			BranchScene.shared().scene(scene, continue: userActivity)
		} else if !connectionOptions.urlContexts.isEmpty {
			BranchScene.shared().scene(scene, openURLContexts: connectionOptions.urlContexts)
		}
  }
}

@interface AppDelegate ()

@interface SceneDelegate ()
@end
@implementation SceneDelegate
// Use `scene` to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`
// If using a storyboard, the `window` property will automatically be initialized and attached to the scene
// This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead)
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
  
    // Workaround for SceneDelegate `continueUserActivity` not getting called on cold start
    NSUserActivity *activity = [[connectionOptions userActivities] allObjects].firstObject;

  	if (activity) {
			[[BranchScene shared] scene:scene continueUserActivity:activity];
		} else if ([[connectionOptions URLContexts] count] != 0) {
			[[BranchScene shared] scene:scene openURLContexts: [connectionOptions URLContexts]];
		}  
}
@end

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

let sharelink = BranchShareLink(universalObject: buo, linkProperties: lp)

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

BranchShareLink *shareLink =
	[[BranchShareLink alloc]
		initWithUniversalObject:buo
		linkProperties:lp];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

let shareLink = BranchShareLink(universalObject: buo, linkProperties: lp)

shareLink.activityItems()

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

BranchShareLink *shareLink =
	[[BranchShareLink alloc]
		initWithUniversalObject:buo
		linkProperties:lp];

[shareLink activityItems];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

let shareLink = BranchShareLink(universalObject: buo, linkProperties: lp)

shareLink.presentActivityViewController(from: self, anchor: nil)

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

BranchShareLink *shareLink =
	[[BranchShareLink alloc]
		initWithUniversalObject:buo
		linkProperties:lp];

[shareLink presentActivityViewControllerFromViewController:self anchor:nil];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

let shareLink = BranchShareLink(universalObject: buo, linkProperties: lp)

shareLink.addLPLinkMetadata("LPLinkMetaData Link Title", icon: iconImg)

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

BranchShareLink *shareLink =
	[[BranchShareLink alloc]
		initWithUniversalObject:buo
		linkProperties:lp];

[shareLink addLPLinkMetadata:@"LPLinkMetadata Link Title" icon:iconImg];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.registerView()

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

[buo registerView]

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.registerView { (params: [AnyHashable: Any]?, error: Error?) in
    print("BUO was listed on spotlight and event was logged: \(String(describing: params))")
}

BranchUniversalObject *buo = [BranchUniversalObject new];
buo.canonicalIdentifier = @"Uniq!";
buo.title = @"Object Title";

// Example 1
[buo registerViewWithCallback:^(NSDictionary * _Nullable params, NSError * _Nullable error) {
	XCTAssertNil(error);
}];

// Example 2
[buo registerViewWithCallback:^(NSDictionary * _Nullable params, NSError * _Nullable error) {
    NSLog(@"BUO was listed on spotlight and event was logged: %@", params);
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

buo.getShortUrl(with: lp) { (url, error) in
	if (error == nil) {
		print("Got my Branch link to share: (url)")
	} else {
		print(String(format: "Branch error : %@", error! as CVarArg))
	}
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

[buo getShortUrlWithLinkProperties:lp andCallback:^(NSString *url, NSError *error) {
	if (!error) {
		NSLog(@"got my Branch invite link to share: %@", url);
	}
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

buo.getShortUrl(with: lp) { (url, error) in
	if (error == nil) {
		print("Got my Branch link to share: (url)")
	} else {
		print(String(format: "Branch error : %@", error! as CVarArg))
	}
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [BranchLinkProperties new];

[buo getShortUrlWithLinkPropertiesAndIgnoreFirstClick:lp andCallback:^(NSString *url, NSError *error) {
	if (!error) {
		NSLog(@"got my Branch invite link to share: %@", url);
	}
}];

let longUrl = Branch.getInstance().getLongURL(withChannel: "channel", andTags: ["tag1"], andFeature: "feature", andStage: "stage", andAlias: "testingLinkAlias123")

NSString *longUrl = [[Branch getInstance] getLongURLWithChannel:@"channel" andTags:@[@"tag1"] andFeature:@"feature" andStage:@"stage" andAlias:@"testingLinkAlias123"];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.showShareSheet(withShareText: "Share Your Monster!") { (activityType, success) in
	if (success) {
		print("Log an event here")
	}
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

[self.buo
	showShareSheetWithShareText:@"Super amazing thing I want to share"
	completion:^(NSString *activityType, BOOL completed) {
		if (completed) {
			NSLog(@"%@", [NSString stringWithFormat:@"Completed sharing to %@", activityType]);
		}
  }
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

let message = "Check out this link"
buo.showShareSheet(with: lp, andShareText: message, from: self) { (activityType, completed) in
  print(activityType ?? "")
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [[BranchLinkProperties alloc] init];

[buo showShareSheetWithLinkProperties:lp
	andShareText:shareText
	fromViewController:self.parentViewController
	completion:^(NSString *activityType, BOOL completed) {
		if (completed) {
			NSLog(@"Completed sharing to %@", activityType);
		} else {
			NSLog(@"Sharing failed");
		}
	}
];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.listOnSpotlight()

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

[buo listOnSpotlight];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.listOnSpotlight { (url, error) in
    if let spotlightUrl = url {
        print("BUO was listed on spotlight: \(spotlightUrl)")
    }
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

// Example 1
[buo listOnSpotlightWithCallback:^(NSString *url, NSError *error) {
	if (!error) {
		NSLog(@"shortURL: %@", url);
	} else {
		NSLog(@"error: %@", error);
	}
}];

// Example 2
[buo listOnSpotlightWithCallback:^(NSString * _Nullable url, NSError * _Nullable error) {
    NSLog(@"BUO was listed on spotlight: %@", url);
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")
let lp = BranchLinkProperties()

buo.listOnSpotlight(with: lp) { (url, error) in
	if (error == nil) {
  	NSLog("Successfully indexed on spotlight \(url)")
	}
}

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];
BranchLinkProperties *lp = [[BranchLinkProperties alloc] init];

// Example 1
[buo listOnSpotlightWithCallback:^(NSString *url, NSError *error) {
	if (!error) {
		NSLog(@"shortURL: %@", url);
	} else {
		NSLog(@"error: %@", error);
	}
}];

// Example 2
[buo listOnSpotlightWithCallback:^(NSString * _Nullable url, NSError * _Nullable error) {
    NSLog(@"BUO was listed on spotlight: %@", url);
}];

let buo = BranchUniversalObject(canonicalIdentifier: "item/12345")

buo.removeFromSpotlight { (error) in
	if (error == nil) {
    print("BUO successfully removed")
  }
 }

BranchUniversalObject *buo =  [[BranchUniversalObject alloc] initWithCanonicalIdentifier:@"item/12345"];

[buo removeFromSpotlightWithCallback:^(NSError * _Nullable error) {
	NSString *title = @"Remove private indexing";
	NSString *message;
	if (!error) {
		message = @"Successfully removed indexing";
	}
	else {
		message = [error description];
	}
}];