register()
A function that registers a placement that can be remotely configured to show a paywall and gate feature access.
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.
Placement names that match a standard Superwall event, such as app_launch, are reserved. In SDK 4.19.1 and later, register reports these names to the handler's onError callback and does not run the feature.
On watchOS and tvOS (4.19.1+), campaigns still evaluate audiences, but cannot show paywalls. A matched non-gated paywall runs the feature; a gated paywall reports an error. See watchOS and tvOS Support for skip and error behavior.
Signature
public func register(
placement: String,
params: [String: Any]? = nil,
handler: PaywallPresentationHandler? = nil,
feature: @escaping () -> Void
)public func register(
placement: String,
params: [String: Any]? = nil,
handler: PaywallPresentationHandler? = nil
)Parameters
Prop
Type
Returns / State
This function returns Void. If you supply a feature block, it will be executed according to the paywall's gating configuration, as described above.
Usage
Superwall.shared.register(
placement: "premium_feature",
params: ["source": "onboarding"]
) {
// Code that unlocks the premium feature
openPremiumScreen()
}Superwall.shared.register(
placement: "onboarding_complete",
params: ["source": "onboarding"],
handler: self
)How is this guide?