Release Note (4.0.0-beta.3)

v.4.0.0-beta.3

Upgrade instructions: https://help.branch.io/developer-hub/ios-sdk-4-integration

• Added BranchConfiguration object which holds every setting that used to be a Branch setter: API and CDN URLs, EU endpoints, log level and logging callback, request tracing callback, network timeout, retry count and interval, third-party API wait time, attribution level, DMA parameters, allowed schemes, URL patterns to ignore, request metadata, pasteboard check on install, App Clip app group and deep link debug params.
• Added new initialization API +[Branch initialize:] to initialize Branch SDK using BranchConfiguration. The initSession… family is removed.
• Added +[Branch updateConfiguration:] to change the configuration after initialization.
  • Removed the old setters:
    -- setBranchKey:
    -- setUseTestBranchKey:
    -- useEUEndpoints
    -- setAPIUrl:
    -- setSafetrackAPIURL:
    -- setNetworkTimeout:
    -- setMaxRetries:
    -- setRetryInterval:
    -- setSDKWaitTimeForThirdPartyAPIs:
    -- addAllowedScheme:/setAllowedSchemes:
    -- setUrlPatternsToIgnore:
    -- checkPasteboardOnInstall
    -- setAppClipAppGroup:
    -- setDeepLinkDebugMode:
    -- setCallbackForTracingRequests:.
  • The Branch Key is no longer read from Info.plist. Pass it to BranchConfiguration.
• Removed getInstance, getInstance: and getTestInstance. Use +[Branch sharedInstance].
• New deep link APIs replace initSession…, continueUserActivity: and handlePushNotification::
  • requestDeepLinkData:callback:
  • requestDeepLinkDataWithLaunchOptions:callback:
  • requestDeepLinkDataWithURL: and requestDeepLinkDataWithURL:sourceApplication:annotation:
  • requestDeepLinkDataWithUserActivity:
  • requestDeepLinkDataWithUserInfo:
  • requestDeepLinkDataWithSceneOptions:scene:callback:
  • requestDeepLinkDataWithScene:openURLContexts: and requestDeepLinkDataWithScene:userActivity:
• Added manual open control. BranchConfiguration.automaticOpenEvents (default YES).
• Added API sendOpen. If BranchConfiguration.automaticOpenEvents is set to NO, use this API to send OPEN events manually.
• Link creation is consolidated into the new BranchLinkBuilder class, which takes BranchLinkProperties. Remove all overloaded versions of following APIs -
  • getShortURLWithLinkProperties:
  • getLongURLWithLinkProperties:
  • getSpotlightURLWithParams:
  • getShortURL…
  • getLongURL…,
  • getLongAppLinkURL…
  • getSpotlightUrlWithParams:
• Added Swift async wrappers via NS_SWIFT_ASYNC_NAME to APIs.
• Replaced setIdentity: / setIdentity:withCallback: with setUserAlias:completion:.
• Removed setTrackingDisabled: and trackingDisabled. Use setConsumerProtectionAttributionLevel: with BranchAttributionLevelNone, and check with +[Branch attributionLevelNone].
• Replaced setDMAParamsForEEA:AdPersonalizationConsent:AdUserDataUsageConsent: with the BranchDMAParameters class and setDMAParameters:.
• Removed limitFacebookAttribution and disableAdNetworkCallouts:.
• Raised the minimum iOS and tvOS deployment target to 15.0 (BranchSDK.xcodeproj, Package.swift, BranchSDK.podspec). Xcode 27 refuses to build the Xcode project or a CocoaPods integration below 15.0.

Release Note (3.14.2)

• Fixed crash for malformed or nil strings coming from pasteboard or spotlight.

We have identified an issue affecting some apps using Branch iOS SDK 3.14.1 where the app may crash on launch under specific device clipboard conditions. Please use 3.14.2.

Release Note (3.14.1)

• Added check for _branch_referrer query param in third-party/redirected links.

Release Note (3.14.0)

• Added APIs disableNextForegroundForTimeInterval:, disableNextForeground and resumeSession to disable and resume automatic tracking of OPEN events. These are experimental APIs. Please refer to warning message in API documentation/comments.

Release Note (3.13.3)

• Fixed Bug - Missing Apple Attribution Token in Install Requests (impacted versions: 3.13.0 - 3.13.2).

Bug Identified
A bug in Branch iOS SDK versions 3.13.0–3.13.2 has been identified that prevented correct event attribution.
Action Required: Please update immediately to ensure accurate tracking and attribution for your campaigns.

Release Note (3.13.2)

• Suppressed deprecated StoreKit API warnings. These APIs will be replaced with StoreKit 2 APIs in upcoming releases.
• Added defensive fix to improve reliability of NSInvocation calls.
• Added some additional debug logging.

Bug Identified
A bug in Branch iOS SDK versions 3.13.0–3.13.2 has been identified that prevented correct event attribution.
Action Required: Please update immediately to ensure accurate tracking and attribution for your campaigns.

Release Note (3.13.1)

• SDK Request Queue will not cache request objects failed with Https Response Codes - 1xx, 2xx, 3xx and 4xx.
• Fixed bug - SDK will send odm_info if Consumer Protection Attribution Level is not set or is set to 'FULL'.

Bug Identified
A bug in Branch iOS SDK versions 3.13.0–3.13.2 has been identified that prevented correct event attribution.
Action Required: Please update immediately to ensure accurate tracking and attribution for your campaigns.

Release Note (3.13.0)

• Added API 'setAnonID' to set custom Meta Anon ID for the current user.
• Added API 'setSDKWaitTimeForThirdPartyAPIs' to set time for which SDK will wait for fetching data from third-party APIs, such as ODM info and Apple Attribution Token.
• Removed apple_receipt and apple_testflight params from the Server Requests.

Release Note (3.12.2)

• Fixed bug where error object was not being forwarded when receiving error from service.
• Fixed bug with Advanced Compliance and Integration Validator.
• Added param 'operational_metrics' in v1/install request.

Release Note (3.12.1)

• Fixed bug - SDK crashes when Meta AEM query param al_applink_data is empty.