Using the Superwall Delegate

Use Superwall's delegate to extend our SDK's functionality across several surface areas by assigning to the delegate property:

class SWDelegate : SuperwallDelegate {
    // Implement delegate methods here
}

// When configuring the SDK...
Superwall.instance.delegate = SWDelegate()

Some common use cases for using the Superwall delegate include:

Custom actions: Respond to custom tap actions from a paywall.
Respond to purchases: See which product was purchased from the presented paywall.
Analytics: Forward events from Superwall to your own analytics.

Below are some commonly used implementations when using the delegate.

Superwall Events

Most of what occurs in Superwall can be viewed using the delegate method to respond to events:

class SWDelegate : SuperwallDelegate {
  override fun handleSuperwallEvent(eventInfo: SuperwallEventInfo) {
    // Handle any relevant events here...
    when (eventInfo.event) {
        is SuperwallPlacement.TransactionComplete -> {
          val transaction = (eventInfo.event as SuperwallPlacement.TransactionComplete).transaction
          val product = (eventInfo.event as SuperwallPlacement.TransactionComplete).product
          val paywallInfo = (eventInfo.event as SuperwallPlacement.TransactionComplete).paywallInfo
          println("Transaction Complete: $transaction, Product: $product, Paywall Info: $paywallInfo")
        }
        else -> {
          // Handle other cases
        }
    }
  }
}

Paywall Custom Actions

Using the custom tap action, you can respond to any arbitrary event from a paywall:

class SWDelegate : SuperwallDelegate {
  override fun handleCustomPaywallAction(withName: String) {
    if (withName == "caffeineLogged") {
      println("Custom paywall action: $withName")
    }
  }
}

You can be informed of subscription status changes using the delegate. If you need to set or handle the status on your own, use a purchase controller — this function is only for informational, tracking or similar purposes:

class SWDelegate : SuperwallDelegate {
  override fun subscriptionStatusDidChange(from: SubscriptionStatus, to: SubscriptionStatus) {
    println("Subscription status changed from $from to $to")
  }
}

Paywall events

The delegate also has callbacks for several paywall events, such dismissing, presenting, and more. Here's an example:

class SWDelegate : SuperwallDelegate {
  override fun didPresentPaywall(withInfo: PaywallInfo) {
    println("Paywall presented: $withInfo")
  }
}

Using the Superwall Delegate

Superwall Events

Paywall Custom Actions

Subscription status changes

Paywall events

On this page