Advanced Configuration

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:

1. debug: Prints all logs from the SDK to the console. Useful for debugging your app if something isn't working as expected.
2. info: Prints errors, warnings, and useful information from the SDK to the console.
3. warn: Prints errors and warnings from the SDK to the console.
4. error: Only prints errors from the SDK to the console.
5. 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:

val options = SuperwallOptions()
options.logging.level = LogLevel.warn
options.logging.scopes = EnumSet.of(LogScope.paywallPresentation, LogScope.paywallTransactions)

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or you can set:
Superwall.instance.logLevel = LogLevel.warn

// Or use the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        logging {
            level = LogLevel.warn
            scopes = EnumSet.of(LogScope.paywallPresentation, LogScope.paywallTransactions)
        }
    }
}

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 placements that result in a paywall for the user when registered. Preloading is smart, only preloading paywalls that belong to audiences 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:

val options = SuperwallOptions()
options.paywalls.shouldPreload = false

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            shouldPreload = false
        }
    }
}

Then, if you'd like to preload paywalls for specific placements you can use preloadPaywalls(forPlacements:):

val eventNames = setOf("campaign_trigger")
Superwall.instance.preloadPaywalls(eventNames)

If you'd like to preload all paywalls you can use preloadAllPaywalls():

Superwall.instance.preloadAllPaywalls()

Note: These methods will not reload any paywalls that have already been preloaded.

Event Tracking Behavior

By default, Superwall allows the SDK to send event collection that supports paywall analytics, reporting, and targeting. Use the platform-specific options below when your app needs to control which SDK events are sent to Superwall.

val options = SuperwallOptions()
options.eventTrackingBehavior = EventTrackingBehavior.NONE

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        eventTrackingBehavior = EventTrackingBehavior.NONE
    }
}

Superwall.instance.eventTrackingBehavior = EventTrackingBehavior.NONE

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:

val options = SuperwallOptions()
options.paywalls.automaticallyDismiss = false

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            automaticallyDismiss = 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:

val options = SuperwallOptions()
options.paywalls.restoreFailed.title = "My Title"
options.paywalls.restoreFailed.message = "My message"
options.paywalls.restoreFailed.closeButtonTitle = "Close"

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            restoreFailed.title = "My Title"
            restoreFailed.message = "My message"
            restoreFailed.closeButtonTitle = "Close"
        }
    }
}

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:

val options = SuperwallOptions()
options.paywalls.transactionBackgroundView = null

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            transactionBackgroundView = null
        }
    }
}

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:

val options = SuperwallOptions()
options.paywalls.shouldShowPurchaseFailureAlert = false

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            shouldShowPurchaseFailureAlert = false
        }
    }
}

Web Purchase Confirmation Alert

When a user completes a purchase via web checkout (app2web flow), you can control whether to show a confirmation alert. By default, this is set to false to prevent duplicate alerts. Set shouldShowWebPurchaseConfirmationAlert to true if you want to show the native confirmation alert:

val options = SuperwallOptions()
options.paywalls.shouldShowWebPurchaseConfirmationAlert = true

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        paywalls {
            shouldShowWebPurchaseConfirmationAlert = true
        }
    }
}

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:

val options = SuperwallOptions()
options.localeIdentifier = "en_GB"

Superwall.configure(
  this,
  apiKey = "MY_API_KEY",
  options = options
)

// Or using the configuration DSL
configureSuperwall("MY_API_KEY") {
    options {
        localeIdentifier = "en_GB"
    }
}

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.