iOS - Present new Paywall Builder paywalls

If you've customized a paywall using the Paywall Builder, you don't need to worry about rendering it in your mobile app code to display it to the user. Such a paywall contains both what should be shown within the paywall and how it should be shown.

warning

This guide is for new Paywall Builder paywalls only which require SDK v3.0 or later. The process for presenting paywalls differs for paywalls designed with different versions of Paywall Builde, remote config paywalls, and Observer mode.

• For presenting Legacy Paywall Builder paywalls, check out iOS - Present legacy Paywall Builder paywalls.
• For presenting Remote config paywalls, see Render paywall designed by remote config.
• For presenting Observer mode paywalls, see iOS - Present Paywall Builder paywalls in Observer mode

Present paywalls in Swift

In order to display the visual paywall on the device screen, do the following:

1. Initialize the visual paywall you want to display by using the .paywallController(for:products:viewConfiguration:delegate:) method:

   Swift

   import Adapty
   import AdaptyUI
   
   let visualPaywall = AdaptyUI.paywallController(
       with: <paywall configuration object>,
       delegate: <AdaptyPaywallControllerDelegate>
   )

   Request parameters:

   Parameter	Presence	Description
   Paywall Configuration	required	An AdaptyUI.PaywallConfiguration object containing visual details of the paywall. Use the AdaptyUI.getPaywallConfiguration(forPaywall:locale:) method. Refer to Fetch Paywall Builder paywalls and their configuration topic for more details.
   Delegate	required	An AdaptyPaywallControllerDelegate to listen to paywall events. Refer to Handling paywall events topic for more details.

   Returns:

   Object	Description
   AdaptyPaywallController	An object, representing the requested paywall screen

2. After the object has been successfully created, you can display it on the screen of the device:

   Swift

   present(visualPaywall, animated: true)

Present paywalls in SwiftUI

In order to display the visual paywall on the device screen, use the .paywall modifier in SwiftUI:

SwiftUI

@State var paywallPresented = false

var body: some View {
	Text("Hello, AdaptyUI!")
			.paywall(
          isPresented: $paywallPresented,
          paywall: <paywall object>,
          viewConfiguration: <LocalizedViewConfiguration>,
          didPerformAction: { action in
              switch action {
                  case .close:
                      paywallPresented = false
                  default:
                      // Handle other actions
                      break
              }
          },
          didFinishPurchase: { product, profile in paywallPresented = false },
          didFailPurchase: { product, error in /* handle the error */ },
          didFinishRestore: { profile in /* check access level and dismiss */  },
          didFailRestore: { error in /* handle the error */ },
          didFailRendering: { error in paywallPresented = false }
      )
}

Parameters:

Parameter	Presence	Description
Paywall Configuration	required	An AdaptyUI.PaywallConfiguration object containing visual details of the paywall. Use the AdaptyUI.getPaywallConfiguration(forPaywall:locale:) method. Refer to Fetch Paywall Builder paywalls and their configuration topic for more details.
Products	optional	Provide an array of AdaptyPaywallProducts to optimize the display timing of products on the screen. If nil is passed, AdaptyUI will automatically fetch the necessary products.

Closure parameters:

Closure parameter	Description
didFinishPurchase	If Adapty.makePurchase() succeeds, this callback will be invoked.
didFailPurchase	If Adapty.makePurchase() fails, this callback will be invoked.
didFinishRestore	If Adapty.restorePurchases() succeeds, this callback will be invoked.
didFailRestore	If Adapty.restorePurchases() fails, this callback will be invoked.
didFailRendering	If an error occurs during the interface rendering, this callback will be invoked.

Refer to the iOS - Handling events topic for other closure parameters.