Skip to content

Commit b5ebbc1

Browse files
committed
better docs
1 parent fae87ea commit b5ebbc1

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

Branch-SDK/Branch-SDK/Branch.h

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,8 +407,18 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
407407
- (void)disableCookieBasedMatching;
408408

409409
/**
410-
If you're using a version of the Facebook SDK that prevents application:didFinishLaunchingWithOptions: from returning
411-
YES/true when a Universal Link is clicked, you should enable this option.
410+
TL;DR: If you're using a version of the Facebook SDK that prevents application:didFinishLaunchingWithOptions: from
411+
returning YES/true when a Universal Link is clicked, you should enable this option.
412+
413+
Long explanation: in application:didFinishLaunchingWithOptions: you should choose one of the following:
414+
415+
1. Always `return YES;`, and do *not* invoke `[[Branch getInstance] accountForFacebookSDKPreventingAppLaunch];`
416+
2. Allow the Facebook SDK to determine whether `application:didFinishLaunchingWithOptions:` returns `YES` or `NO`,
417+
and invoke `[[Branch getInstance] accountForFacebookSDKPreventingAppLaunch];`
418+
419+
The reason for this second option is that the Facebook SDK will return `NO` if a Universal Link opens the app
420+
but that UL is not a Facebook UL. Some developers prefer not to modify
421+
`application:didFinishLaunchingWithOptions:` to always return `YES` and should use this method instead.
412422
*/
413423
- (void)accountForFacebookSDKPreventingAppLaunch;
414424

0 commit comments

Comments
 (0)