register()

Purpose

Registers a placement so that when it's added to a campaign on the Superwall Dashboard, it can trigger a paywall and optionally gate access to a feature.

Signature

async register(params: {
  placement: string
  params?: Map<string, any> | Record<string, any>
  handler?: PaywallPresentationHandler
  feature?: () => void
}): Promise<void>

Parameters

Returns / State

Returns a Promise that resolves when registration completes. If you supply a feature callback, it will be executed according to the paywall's gating configuration, as described above.

Usage

With feature callback:

Superwall.shared.register({
  placement: "premium_feature",
  params: {
    source: "onboarding"
  },
  feature: () => {
    // Code that unlocks the premium feature
    openPremiumScreen()
  }
})

Using promise chaining:

await Superwall.shared.register({
  placement: "premium_feature",
  params: {
    source: "onboarding"
  }
}).then(() => {
  // Code that unlocks the premium feature
  openPremiumScreen()
})

With presentation handler:

import { PaywallPresentationHandler } from "@superwall/react-native-superwall"

const handler = new PaywallPresentationHandler()
handler.onPresent((info) => {
  console.log("Paywall presented:", info.name)
})
handler.onDismiss((info, result) => {
  console.log("Paywall dismissed:", result)
})

Superwall.shared.register({
  placement: "onboarding_complete",
  params: {
    source: "onboarding"
  },
  handler: handler
})

Behavior

This behavior is remotely configurable via the Superwall Dashboard:

• For Non-Gated paywalls, the feature callback is executed when the paywall is dismissed or if the user is already paying.
• For Gated paywalls, the feature callback is executed only if the user is already paying or if they begin paying.
• If no paywall is configured, the feature callback is executed immediately.
• If no feature callback is provided, the returned promise resolves when registration completes.
• If a feature callback is provided, the returned promise always resolves after the feature callback is executed.

Note: The feature callback will not be executed if an error occurs during registration. Such errors can be detected via the handler.