The externalAccountId for the current user. Provided to Google Play billing upon purchase as a SHA256 of the userId. If passIdentifiersToPlayStore option is provided, this will be the userId.

integrationAttributes

val integrationAttributes: Map<String, String>

Gets the current integration identifiers as a map.

isLoggedIn

val isLoggedIn: Boolean

Indicates whether the user is logged in to Superwall.

isPaywallPresented

val isPaywallPresented: Boolean

Determines whether a paywall is being presented.

latestPaywallInfo

val latestPaywallInfo: PaywallInfo?

The PaywallInfo object of the most recently presented view.

localeIdentifier

var localeIdentifier: String?

logLevel

var logLevel: LogLevel

Specifies the detail of the logs returned from the SDK to the console.

options

val options: SuperwallOptions

A convenience variable to access and change the paywall options that you passed to configure.

overrideProductsByName

var overrideProductsByName: Map<String, String>

A map of product name to product identifier that allows you to override products on all paywalls.

paywallView

val paywallView: PaywallView?

The presented paywall view.

placements

val placements: SharedFlow<SuperwallEventInfo>

A flow emitting all Superwall placements as an alternative to delegate.

subscriptionStatus

val subscriptionStatus: StateFlow<SubscriptionStatus>

userAttributes

val userAttributes: Map<String, Any>

Properties stored about the user, set using setUserAttributes.

userId

val userId: String

The current user's id.

Functions

cancelAllScheduledNotifications

fun cancelAllScheduledNotifications()

Removes all of Superwall's pending local notifications.

confirmAllAssignments

suspend fun confirmAllAssignments(): Result<List<ConfirmedAssignment>>

fun Superwall.confirmAllAssignments(callback: (Result<List<ConfirmedAssignment>>) -> Unit)

Confirms all experiment assignments and returns them in an array.

consume

suspend fun consume(purchaseToken: String): Result<String>

fun consume(purchaseToken: String, onConsumed: (Result<String>) -> Unit)

Initiates a consumption of an In-App product.

deviceAttributes

suspend fun deviceAttributes(): Map<String, Any?>

Properties stored about the device session, set internally by Superwall

dismiss

suspend fun Superwall.dismiss()

Dismisses the presented paywall, if one exists.

dismissForNextPaywall

suspend fun Superwall.dismissForNextPaywall()

Dismisses the presented paywall, if it exists, in order to present a different one.

dismissSync

fun Superwall.dismissSync()

Dismisses the presented paywall synchronously, if one exists. Warning: This blocks the calling thread.

dismissSyncForNextPaywall

fun Superwall.dismissSyncForNextPaywall()

Dismisses the presented paywall synchronously, if it exists, in order to present a different one. Warning: This blocks the calling thread.

dispatchKeyEvent

fun Superwall.dispatchKeyEvent(keyEvent: KeyEvent)

dispatchMotionEvent

fun Superwall.dispatchMotionEvent(motionEvent: MotionEvent)

eventDidOccur

open suspend override fun eventDidOccur(paywallEvent: PaywallWebEvent, paywallView: PaywallView)

getAssignments

fun getAssignments(): Result<List<ConfirmedAssignment>>

Gets an array of all confirmed experiment assignments.

getCustomerInfo

fun getCustomerInfo(): CustomerInfo

Gets the current CustomerInfo synchronously.

getJavaDelegate

@JvmName(name = "getDelegate")

fun getJavaDelegate(): SuperwallDelegateJava?

Gets the Java delegate that handles Superwall lifecycle events.

getPaywall

suspend fun Superwall.~~getPaywall~~(placement: String, params: Map<String, Any>? = null, paywallOverrides: PaywallOverrides? = null, delegate: PaywallViewCallback): Result<PaywallView>

getPaywallOrThrow

suspend fun Superwall.~~getPaywallOrThrow~~(placement: String, params: Map<String, Any>? = null, paywallOverrides: PaywallOverrides? = null, delegate: PaywallViewCallback): PaywallView

getPaywallSync

fun Superwall.getPaywallSync(request: PresentationRequest, onStateChanged: (PaywallState) -> Unit = {}): Either<PaywallView, Throwable>

Gets a paywall to present synchronously, providing updates on the lifecycle of the paywall through a callback. Warning: This blocks the calling thread until the paywall is returned.

getPresentationResult

suspend fun Superwall.getPresentationResult(placement: String, params: Map<String, Any>? = null): Result<PresentationResult>

Preemptively gets the result of registering an event.

getPresentationResultSync

fun Superwall.getPresentationResultSync(placement: String, params: Map<String, Any>? = null): Result<PresentationResult>

Synchronously preemptively gets the result of registering an event.

getProducts

suspend fun getProducts(vararg productIds: String): Result<Map<String, StoreProduct>>

Given a list of product identifiers, returns a map of identifiers to StoreProduct objects.

handleDeepLink

fun handleDeepLink(uri: Uri): Result<Boolean>

Handles a deep link sent to your app to open a preview of your paywall.

identify

fun Superwall.identify(userId: String, options: IdentityOptions? = null)

observe

fun observe(state: PurchasingObserverState)

Observe purchases made without using Paywalls.

observePurchaseError

fun observePurchaseError(product: ProductDetails, error: Throwable)

Convenience method to observe purchase errors.

observePurchaseResult

fun observePurchaseResult(billingResult: BillingResult, purchases: List<Purchase>)

Convenience method to observe successful purchases.

observePurchaseStart

fun observePurchaseStart(product: ProductDetails)

Convenience method to observe when a purchase flow begins.

openRestoreOnWeb

fun Superwall.openRestoreOnWeb()

preloadAllPaywalls

fun preloadAllPaywalls()

Preloads all paywalls that the user may see based on campaigns and triggers turned on in your Superwall dashboard.

preloadPaywalls

fun preloadPaywalls(placementNames: Set<String>)

Preloads paywalls for specific event names.

purchase

suspend fun purchase(product: ProductDetails): Result<PurchaseResult>

Initiates a purchase of ProductDetails.

suspend fun purchase(product: StoreProduct): Result<PurchaseResult>

Initiates a purchase of StoreProduct.

suspend fun purchase(productId: String): Result<PurchaseResult>

Initiates a purchase of a product with the given productId.

fun purchase(product: ProductDetails, onFinished: (Result<PurchaseResult>) -> Unit)

fun purchase(productId: String, onFinished: (Result<PurchaseResult>) -> Unit)

fun purchase(product: StoreProduct, onFinished: (Result<PurchaseResult>) -> Unit)

Initiates a purchase of a StoreProduct with a callback.

refreshConfiguration

fun refreshConfiguration()

Forces a configuration refresh. Used only for hot reload or explicit testing/debugging cases. Do not use unless explicitly instructed by Superwall dev team.

@JvmOverloads

fun Superwall.register(placement: String, params: Map<String, Any>? = null, handler: PaywallPresentationHandler? = null, feature: () -> Unit? = null)

Registers an event to access a feature. When the event is added to a campaign on the Superwall dashboard, it can show a paywall.

reset

fun reset()

Resets the userId, on-device paywall assignments, and data stored by Superwall.

restorePurchases

suspend fun restorePurchases(): Result<RestorationResult>

Restores purchases

fun restorePurchases(onFinished: (Result<RestorationResult>) -> Unit): Job

Restores purchases and returns the result in a callback.

setIntegrationAttributes

fun setIntegrationAttributes(attributes: Map<AttributionProvider, String>)

Sets 3rd party integration identifiers for this user. The identifiers will be passed to Superwall backend.

setInterfaceStyle

fun setInterfaceStyle(interfaceStyle: InterfaceStyle?)

Sets the user interface style, which overrides the system setting. Set to null to revert back to using the system setting.

setJavaDelegate

@JvmName(name = "setDelegate")

fun setJavaDelegate(newValue: SuperwallDelegateJava?)

Sets the Java delegate that handles Superwall lifecycle events.

setPlatformWrapper

fun setPlatformWrapper(wrapper: String, version: String)

Do not use this function, this is for internal use only.

setSubscriptionStatus

fun setSubscriptionStatus(subscriptionStatus: SubscriptionStatus)

Sets the entitlement status and updates the corresponding entitlement collections.

fun setSubscriptionStatus(vararg entitlements: String)

Simplified version of Superwall.setSubscriptionStatus that allows you to set the entitlements by passing in an array of strings. An empty list is treated as SubscriptionStatus.Inactive. Example: setSubscriptionStatus("default", "pro") equals SubscriptionStatus.Active(setOf(Entitlement("default"), Entitlement("pro"))) setSubscriptionStatus() equals SubscriptionStatus.Inactive

setUserAttributes

fun Superwall.setUserAttributes(attributes: Map<String, Any?>)

showAlert

fun showAlert(title: String? = null, message: String? = null, actionTitle: String? = null, closeActionTitle: String = "Done", action: () -> Unit? = null, onClose: () -> Unit? = null)

Shows an alert with provided properties over the paywall UI. Will only show if the current paywall exists/is presented.

togglePaywallSpinner

fun togglePaywallSpinner(isHidden: Boolean)

Toggles the paywall loading spinner on and off.