Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 4.62 KB

V9_MIGRATION.md

File metadata and controls

115 lines (76 loc) · 4.62 KB
Raw

Braintree iOS Drop-in v9 Migration Guide

See the CHANGELOG for a complete list of changes. This migration guide outlines the basics for updating your client integration from v8 to v9.

Documentation for v9 will be published to https://developer.paypal.com/braintree/docs once it is available for general release.

Table of Contents

  1. Supported Versions
  2. Swift Package Manager
  3. CocoaPods
  4. Carthage
  5. UI Customization
  6. Accessibility
  7. Drop-in Result
  8. Venmo
  9. 3D Secure

Supported Versions

v9 supports a minimum deployment target of iOS 12+. It requires the use of Xcode 12+ and Swift 5.1+.

Swift Package Manager

v9 adds support for Swift Package Manager. To add the BraintreeDropIn package to your Xcode project, select File > Swift Packages > Add Package Dependency and enter https://github.com/braintree/braintree-ios-drop-in as the repository URL. Tick the checkbox for BraintreeDropIn.

If you look at your app target, you will see that the BraintreeDropIn library is automatically linked as a framework to your app (see General > Frameworks, Libraries, and Embedded Content).

CocoaPods

v9 includes the Braintree/Apple-Pay, Braintree/Venmo, and Braintree/UnionPay subspecs by default in BraintreeDropIn. You no longer need to manually include these subspecs in your Podfile.

v9 combines BraintreeDropIn/UIKit into BraintreeDropIn. You no longer need to include the BraintreeDropIn/UIKit subspec in your Podfile.

Carthage

v9 drops support for Carthage. We recommend using Swift Package Manager.

UI Customization

v9 introduces BTDropInUICustomization, which you can use to customize Drop-in's UI. Instantiate an instance of BTDropInUICustomization using the light, dark or dynamic color schemes, and then override additional properties as needed. Set your instance of BTDropInUICustomization on BTDropInRequest's uiCustomization property.

let uiCustomization = BTDropInUICustomization(colorScheme: .light)
uiCustomization.fontFamily = "Helvetica"
uiCustomization.boldFontFamily = "Helvetica Bold"

let dropInRequest = BTDropInRequest()
dropInRequest.uiCustomization = uiCustomization

Delete any code that used BTUIKAppearance to customize Drop-in's UI.

Accessibility

Dynamic Type

In v9, Dynamic Type is enabled by default for both system and custom fonts. We strongly encourage you to leave this feature on, but if you need to disable it, you may do so by setting disableDynamicType to true on BTDropInUICustomization.

let uiCustomization = BTDropInUICustomization(colorScheme: .light)
uiCustomization.disableDynamicType = true

let dropInRequest = BTDropInRequest()
dropInRequest.uiCustomization = uiCustomization

Drop-in Result

The isCancelled property on BTDropInResult has been changed to isCanceled.

The paymentOptionType property on BTDropInResult has been changed to paymentMethodType. The name of this enum has changed from BTUIKPaymentOptionType to BTDropInPaymentMethodType.

The fetch method has been renamed to mostRecentPaymentMethod:

BTDropInResult.mostRecentPaymentMethod(forClientToken: authorization) { result, error in
  guard let result = result, error == nil else {
    // either an error occurred or the customer doesn't have any vaulted payment methods
    return
  }

  if result.paymentMethodType == .applePay {
    // Apple Pay is the most recently selected payment method
    // Note that result.paymentMethod will be nil in this case; display Apple Pay button and tokenize using `BTApplePayClient`
  }

  // Update your UI
  let type = result.paymentMethodType
  let icon = result.paymentIcon
  let description = result.paymentDescription

  // Use the payment method to transact
  let paymentMethod = result.paymentMethod
}

Venmo

In v9, BTDropInRequest has a venmoRequest property that can be used to specify options for the Venmo flow. v9 also removes the vaultVenmo property. If you were previously using vaultVenmo, you should now use venmoRequest.vault instead.

let venmoRequest = BTVenmoRequest()
venmoRequest.vault = true
// set additional Venmo options as needed

let dropInRequest = BTDropInRequest()
dropInRequest.venmoRequest = venmoRequest

If you do not set venmoRequest, vaulting will be on by default during the Venmo flow.

3D Secure

v9 removes the threeDSecureVerifcation property from BTDropInRequest. 3DS will always be requested if threeDSecureRequest is not nil and 3DS is enabled in the Control Panel.