Superwall Android SDK/com.superwall.sdk.paywall.manager/PaywallViewCache

PaywallViewCache

class PaywallViewCache(val appCtx: Context, val viewStorage: ViewStorage, val activityProvider: ActivityProvider, val deviceHelper: DeviceHelper, @ColorRes loadingColor: Int? = null, val actor: SequentialActor<PaywallCacheContext, PaywallCacheState>) : PaywallCacheContext(source)

Cache for paywall, loading, and shimmer views.

State is owned by a SequentialActor — every mutation is enqueued through a single FIFO consumer, so state.value always reflects the latest committed data and there are no races between save/get, remove/save, or concurrent acquire calls. ViewStorage is kept as a write-through mirror because external readers (SuperwallPaywallActivity, DebugView) read it directly. Every write must go through this cache (save, storeView, removeView, ...) so the two never disagree about which keys exist.

Constructors

PaywallViewCache

constructor(appCtx: Context, viewStorage: ViewStorage, activityProvider: ActivityProvider, deviceHelper: DeviceHelper, @ColorRes loadingColor: Int? = null, actor: SequentialActor<PaywallCacheContext, PaywallCacheState>)

Properties

activePaywallVcKey

var activePaywallVcKey: String?

activePaywallView

val activePaywallView: PaywallView?

activityProvider

open override val activityProvider: ActivityProvider

actor

open override val actor: SequentialActor<PaywallCacheContext, PaywallCacheState>

appCtx

open override val appCtx: Context

ctx

open val ctx: Context

deviceHelper

open override val deviceHelper: DeviceHelper

entries

val entries: Map<String, View>

scope

open override val scope: CoroutineScope

state

open override val state: StateFlow<PaywallCacheState>

Delegate state reads to the actor.

viewStorage

open override val viewStorage: ViewStorage

Functions

acquireLoadingView

fun acquireLoadingView(): PaywallPurchaseLoadingView

Synchronous because PaywallView.present is non-suspend.

acquireShimmerView

fun acquireShimmerView(): PaywallShimmerView

effect

open fun effect(action: TypedAction<PaywallCacheContext>)

Fire-and-forget dispatch of a sub-action on this context's actor.

getAllPaywallViews

fun getAllPaywallViews(): List<PaywallView>

getPaywallView

fun getPaywallView(key: String): PaywallView?

immediate

open suspend fun immediate(action: TypedAction<PaywallCacheContext>)

immediateUntil

open suspend fun immediateUntil(action: TypedAction<PaywallCacheContext>, until: (PaywallCacheState) -> Boolean)

removeAll

suspend fun removeAll()

removePaywallView

suspend fun removePaywallView(identifier: PaywallIdentifier)

removeView

fun removeView(key: String)

Synchronous counterpart of storeView.

save

suspend fun save(paywallView: PaywallView, identifier: PaywallIdentifier)

sideEffect

open fun sideEffect(what: suspend () -> Unit)

storeView

fun storeView(key: String, view: View)

Stores a view under an arbitrary key (activity launch and restore keys, debug views). Synchronous because callers hand key to an Activity that reads ViewStorage as soon as it is created. Both writes are atomic map operations, so no queued action is needed for consistency.

update

open override fun update(reducer: Reducer<PaywallCacheState>)

Apply a state reducer inline.