Retrieving and Presenting a Paywall Yourself
Get a paywall yourself with getPaywall on iOS and present the PaywallViewController or SwiftUI PaywallView however you like, with skip and error handling.
If you want complete control over the paywall presentation process, you can use getPaywall(forPlacement:params:paywallOverrides:delegate:). This returns the UIViewController subclass PaywallViewController, which you can then present however you like. Or, you can use a SwiftUI View via PaywallView. The following is code is how you'd mimic register:
final class MyViewController: UIViewController {
private func presentPaywall() async {
do {
// 1
let paywallVc = try await Superwall.shared.getPaywall(
forPlacement: "campaign_trigger",
delegate: self
)
self.present(paywallVc, animated: true)
} catch let skippedReason as PaywallSkippedReason {
// 2
switch skippedReason {
case .holdout,
.noAudienceMatch,
.placementNotFound:
break
}
} catch {
// 3
print(error)
}
}
private func launchFeature() {
// Insert code to launch a feature that's behind your paywall.
}
}
// 4
extension MyViewController: PaywallViewControllerDelegate {
func paywall(
_ paywall: PaywallViewController,
didFinishWith result: PaywallResult,
shouldDismiss: Bool
) {
if shouldDismiss {
paywall.dismiss(animated: true)
}
switch result {
case .purchased,
.restored:
launchFeature()
case .declined:
let closeReason = paywall.info.closeReason
let featureGating = paywall.info.featureGatingBehavior
if closeReason != .forNextPaywall && featureGating == .nonGated {
launchFeature()
}
}
}
}@interface MyViewController : UIViewController
- (void)presentPaywall;
@end
@interface MyViewController () <SWKPaywallViewControllerDelegate>
@end
@implementation MyViewController
- (void)presentPaywall {
// 1
[[Superwall sharedInstance] getPaywallForEvent:@"campaign_trigger" params:nil paywallOverrides:nil delegate:self completion:^(SWKGetPaywallResult * _Nonnull result) {
if (result.paywall != nil) {
[self presentViewController:result.paywall animated:YES completion:nil];
} else if (result.skippedReason != SWKPaywallSkippedReasonNone) {
switch (result.skippedReason) {
// 2
case SWKPaywallSkippedReasonHoldout:
case SWKPaywallSkippedReasonUserIsSubscribed:
case SWKPaywallSkippedReasonEventNotFound:
case SWKPaywallSkippedReasonNoRuleMatch:
case SWKPaywallSkippedReasonNone:
break;
};
} else if (result.error) {
// 3
NSLog(@"%@", result.error);
}
}];
}
-(void)launchFeature {
// Insert code to launch a feature that's behind your paywall.
}
// 4
- (void)paywall:(SWKPaywallViewController *)paywall didFinishWithResult:(enum SWKPaywallResult)result shouldDismiss:(BOOL)shouldDismiss {
if (shouldDismiss) {
[paywall dismissViewControllerAnimated:true completion:nil];
}
SWKPaywallCloseReason closeReason;
SWKFeatureGatingBehavior featureGating;
switch (result) {
case SWKPaywallResultPurchased:
case SWKPaywallResultRestored:
[self launchFeature];
break;
case SWKPaywallResultDeclined:
closeReason = paywall.info.closeReason;
featureGating = paywall.info.featureGatingBehavior;
if (closeReason != SWKPaywallCloseReasonForNextPaywall && featureGating == SWKFeatureGatingBehaviorNonGated) {
[self launchFeature];
}
break;
}
}
@endimport SuperwallKit
struct MyAwesomeApp: App {
@State var store: AppStore = .init()
init() {
Superwall.configure(apiKey: "MyAPIKey")
}
var body: some Scene {
WindowGroup {
ContentView()
.fullScreenCover(isPresented: $store.showPaywall) {
// You can just use 'placement' at a minimum. The 'feature'
// Closure fires if they convert
PaywallView(placement: "a_placement", onSkippedView: { skip in
switch skip {
case .userIsSubscribed,
.holdout(_),
.noRuleMatch,
.eventNotFound:
MySkipView()
}
}, onErrorView: { error in
MyErrorView()
}, feature: {
// User is subscribed as a result of the paywall purchase
// Or they already were (which would happen in `onSkippedView`)
})
}
}
}
}import androidx.compose.runtime.Composable
import com.superwall.sdk.compose.PaywallComposable
import com.superwall.sdk.paywall.view.delegate.PaywallViewCallback
@Composable
fun EmbeddedPaywall(placement: String, delegate: PaywallViewCallback) {
PaywallComposable(
placement = placement,
delegate = delegate,
)
}This does the following:
- Gets the paywall view controller.
- Handles the cases where the paywall was skipped.
- Catches any presentation errors.
- Implements the delegate. This is called when the user is finished with the paywall. First, it checks
shouldDismiss. If this is true then is dismissed the paywall from view before launching any features. This may depend on theresultdepending on how you first presented your view. Then, it switches over theresult. If the result ispurchasedorrestoredthe feature can be launched. However, if the result isdeclined, it checks that the thefeatureGatingproperty ofpaywall.infoisnonGatedand that thecloseReasonisn't.forNextPaywall.
Best practices
- Make sure to prevent a paywall from being accessed after a purchase has occurred.
If a user purchases from a paywall, it is your responsibility to make sure that the user can't access that paywall again. For example, if after successful purchase you decide to push a new view on to the navigation stack, you should make sure that the user can't go back to access the paywall.
- Make sure the paywall view controller deallocates before presenting it elsewhere.
If you have a paywall view controller presented somewhere and you try to present the same view controller elsewhere, you will get a crash. For example, you may have a paywall in a tab bar controller, and then you also try to present it modally. We plan on improving this, but currently it's your responsibility to ensure this doesn't happen.
- Listening for Loading State Changes.
If you have logic that depends on the progress of the paywall's loading state, you can use the delegate function paywall(_:loadingStateDidChange:). Or, if you have an instance of a PaywallViewController, you can use the published property:
let stateSub = paywall.$loadingState.sink { state in
print(state)
}Platform and Placement Requirements
getPaywall and PaywallView are unavailable on watchOS and tvOS. See watchOS and tvOS Support.
In SDK 4.19.1 and later, both APIs reject placement names that match a standard Superwall event, such as app_launch. Use your own placement name. getPaywall throws an error, and PaywallView passes it to onErrorView.
Paywalls respect the supported orientations of the screen they cover in SDK 4.19.1 and later, including apps that restrict orientation in a view controller.
How is this guide?
StoreKit 1 vs StoreKit 2
Choose StoreKit 1 or StoreKit 2 in the Superwall iOS SDK. See the default, when the SDK uses StoreKit 1 anyway, and which features need StoreKit 2.
Using the Presentation Handler
Track when an iOS paywall presents, dismisses, errors or is skipped by passing a PaywallPresentationHandler to register in the Superwall SDK.