1.x to 2.x Migration Guide

1// Setup using shared configuration,
2PLKPlaidLink.setup { (success, error) in /* … */ }
3
4// using shared configuration and item-add token
5PLKPlaidLink.setupWithSharedConfiguration(usingItemAddToken:itemAddToken) { (success, error) in /* … */ }
6
7// using custom configuration,
8PLKPlaidLink.setup(with: linkConfiguration) { (success, error) in /* … */ }
9
10// using custom configuration and item-add token,
11PLKPlaidLink.setupWithConfiguration(with: linkConfiguration, itemAddToken: itemAddToken)
12    { (success, error) in /* … */ }
13
14// using public-token and shared configuration
15PLKPlaidLink.setup(withPublicToken:publicToken) { (success, error) in /* … */ }
16
17// using public-token and custom configuration
18PLKPlaidLink.setup(withPublicToken:publicToken, configuration:linkConfiguration) { (success, error) in /* … */ }
19
20// using public-token, item-add token, and shared configuration
21PLKPlaidLink.setup(withPublicToken:publicToken, itemAddToken:itemAddToken) { (success, error) in /* … */ }
22
23// using public-token, item-add token, and custom configuration
24PLKPlaidLink.setup(withPublicToken:publicToken, itemAddToken:itemAddToken, configuration:linkConfiguration)
25    { (success, error) in /* … */ }
26
27// using public-token, link-token, and shared configuration
28PLKPlaidLink.setup(withPublicToken:publicToken, linkToken:linkToken) { (success, error) in /* … */ }
29
30// using public-token, link-token, and custom configuration
31PLKPlaidLink.setup(withPublicToken:publicToken, linkToken:linkToken, configuration:linkConfiguration)
32    { (success, error) in /* … */ }

1// For recommended Link Token based configuration use:
2let linkTokenConfiguration = LinkTokenConfiguration(token: linkToken)
3    { success in /* … */ }
4
5// To continue using public key based configuration for the interim use:
6let linkPublicKeyConfiguration = LinkPublicKeyConfiguration(
7            clientName: "Link Demo",
8            environment: .sandbox,
9            products: [.transactions, .auth],
10            language: "en"
11            token: .publicKey("<#YOUR_PUBLIC_KEY#>"),
12            countryCodes: ["US"]) { (success) in /* … */ }

1switch Plaid.create(linkTokenConfiguration) {
2  case .failure(let error):
3    print("Unable to create Plaid Handler due to: \(error)")
4  case .success(let handler)
5    // Store the handler for later use and call open on it when Link should start
6    self.handler = handler
7}

1present(linkViewController, animated: true)

1// Let the handler present Link using one of the application's view controllers.
2handler.open(presentUsing: .viewController(self))
3
4// or present Link yourself in a custom manner using a closure.
5handler.open(presentUsing: .custom({ (linkViewController) in /* … */ }))

1let onSuccessHandler: OnSuccessHandler = { (success) in
2  // Send success.publicToken to your server and exchange it for an access token
3  // Process any metadata according to your needs, e.g. metadata.institution.name
4}
5// Pass onSuccessHandler to the onSuccess parameter of the LinkTokenConfiguration or LinkPublicKeyConfiguration initializer

1let onExitHandler: OnExitHandler = { (exit) in
2    if let error = exit.error {
3        // Handle errors according to your app.
4        switch error.errorCode {
5        case .rateLimitExceeded(let code):
6            print("Encountered rate limit \(code)")
7        default:
8            print("Unhandled error \(error.errorCode)")
9        }
10    }
11    // Process any metadata depending on your needs, e.g. exit.metadata.institution.name
12}
13linkConfiguration.onExit = onExitHandler

1let onEventHandler: OnEventHandler = { (event) in
2    // Handle events and metadata according to your app.
3    let metadata = event.metadata
4    switch event.eventName {
5    case .selectInstitution:
6        // Process any metadata according to your needs, e.g. metadata.institutionName
7        print("Selected institution \(metadata.institutionName ?? "") (\(metadata.institutionID ?? "")")
8    default:
9        print("Ignored event \(event)")
10    }
11}
12linkConfiguration.onEvent = onEventHandler