Passing in options
When configuring the SDK you can pass in options that configure Superwall, the paywall presentation, and its appearance.
Logging
Logging is enabled by default in the SDK and is controlled by two properties: level
and scopes
.
level
determines the minimum log level to print to the console. There are five types of log level:
- debug: Prints all logs from the SDK to the console. Useful for debugging your app if something isn’t working as expected.
- info: Prints errors, warnings, and useful information from the SDK to the console.
- warn: Prints errors and warnings from the SDK to the console.
- error: Only prints errors from the SDK to the console.
- none: Turns off all logs.
The SDK defaults to info
.
scopes
defines the scope of logs to print to the console. For example, you might only care about logs relating to paywallPresentation
and paywallTransactions
. This defaults to .all
. Check out LogScope for all possible cases.
You set these properties like this:
Preloading Paywalls
Paywalls are preloaded by default when the app is launched from a cold start. The paywalls that are preloaded are determined by the list of events that result in a paywall for the user when registered. Preloading is smart, only preloading paywalls that belong to rules that could be matched.
Paywalls are cached by default, which means after they load once, they don’t need to be reloaded from the network unless you make a change to them on the dashboard. However, if you have a lot of paywalls, preloading may increase network usage of your app on first load of the paywalls and result in slower loading times overall.
You can turn off preloading by setting shouldPreload
to false
:
Then, if you’d like to preload paywalls for specific event names you can use preloadPaywalls(forEvents:)
:
If you’d like to preload all paywalls you can use preloadAllPaywalls()
:
Note: These methods will not reload any paywalls that have already been preloaded.
External Data Collection
By default, Superwall sends all registered events and properties back to the Superwall servers. However, if you have privacy concerns, you can stop this by setting isExternalDataCollectionEnabled
to false
:
Disabling this will not affect your ability to create triggers based on properties.
Automatically Dismissing the Paywall
By default, Superwall automatically dismisses the paywall when a product is purchased or restored. You can disable this by setting automaticallyDismiss
to false
:
To manually dismiss the paywall , call Superwall.shared.dismiss()
.
Custom Restore Failure Message
You can set the title, message and close button title for the alert that appears after a restoration failure:
Haptic Feedback
On iOS, the paywall uses haptic feedback by default after a user purchases or restores a product, opens a URL from the paywall, or closes the paywall. To disable this, set the isHapticFeedbackEnabled
PaywallOption
to false:
Note: Android does not use haptic feedback.
Transaction Background View
During a transaction, we add a UIActivityIndicator
behind the view to indicate a loading status. However, you can remove this by setting the transactionBackgroundView
to nil
:
Purchase Failure Alert
When a purchase fails, we automatically present an alert with the error message. If you’d like to show your own alert after failure, set the shouldShowPurchaseFailureAlert
PaywallOption
to false
:
Locale Identifier
When evaluating rules, the device locale identifier is set to autoupdatingCurrent
. However, you can override this if you want to test a specific locale:
For a list of locales that are available on iOS, take a look at this list. You can also preview your paywall in different locales using In-App Previews.
Game Controller
If you’re using a game controller, you can enable this in SuperwallOptions
too. Check out our Game Controller Support article.
Take a look at SuperwallOptions in our SDK reference for more info.