Superwall Android SDK/com.superwall.sdk.config/ConfigManager

ConfigManager

open class ConfigManager(val context: Context, val storeManager: StoreManager, val entitlements: Entitlements, val storage: Storage, val network: SuperwallAPI, val deviceHelper: DeviceHelper, var options: SuperwallOptions, val paywallManager: PaywallManager, val webPaywallRedeemer: () -> WebPaywallRedeemer, val factory: ConfigManager.Factory, val assignments: Assignments, val paywallPreload: PaywallPreload, ioScope: IOScope, val tracker: suspend (TrackableSuperwallEvent) -> Unit, val testMode: TestMode? = null, val identityManager: () -> IdentityManager? = null, val setSubscriptionStatus: (SubscriptionStatus) -> Unit? = null, val awaitUtilNetwork: suspend () -> Unit = { context.awaitUntilNetworkExists() }, val activateTestMode: suspend (Config, Boolean) -> Unit = { _, _ -> }, val actor: StateActor<ConfigContext, ConfigState>) : ConfigContext(source)

Constructors

ConfigManager

constructor(context: Context, storeManager: StoreManager, entitlements: Entitlements, storage: Storage, network: SuperwallAPI, deviceHelper: DeviceHelper, options: SuperwallOptions, paywallManager: PaywallManager, webPaywallRedeemer: () -> WebPaywallRedeemer, factory: ConfigManager.Factory, assignments: Assignments, paywallPreload: PaywallPreload, ioScope: IOScope, tracker: suspend (TrackableSuperwallEvent) -> Unit, testMode: TestMode? = null, identityManager: () -> IdentityManager? = null, setSubscriptionStatus: (SubscriptionStatus) -> Unit? = null, awaitUtilNetwork: suspend () -> Unit = { context.awaitUntilNetworkExists() }, activateTestMode: suspend (Config, Boolean) -> Unit = { _, _ -> }, actor: StateActor<ConfigContext, ConfigState>)

Types

Factory

interface Factory : RequestFactory, DeviceInfoFactory, RuleAttributesFactory, DeviceHelperFactory, StoreTransactionFactory, HasExternalPurchaseControllerFactory

Properties

activateTestMode

open override val activateTestMode: suspend (Config, Boolean) -> Unit

actor

open override val actor: StateActor<ConfigContext, ConfigState>

assignments

open override val assignments: Assignments

awaitUtilNetwork

open override val awaitUtilNetwork: suspend () -> Unit

config

val config: Config?

context

open override val context: Context

deviceHelper

open override val deviceHelper: DeviceHelper

entitlements

open override val entitlements: Entitlements

factory

open override val factory: ConfigManager.Factory

hasConfig

val hasConfig: Flow<Config>

identityManager

open override val identityManager: () -> IdentityManager?

network

open override val network: SuperwallAPI

options

open override var options: SuperwallOptions

paywallManager

open override val paywallManager: PaywallManager

paywallPreload

open override val paywallPreload: PaywallPreload

scope

open override val scope: CoroutineScope

setSubscriptionStatus

open override val setSubscriptionStatus: (SubscriptionStatus) -> Unit?

state

open override val state: StateFlow<ConfigState>

Delegate state reads to the actor.

storage

open override val storage: Storage

storeManager

open override val storeManager: StoreManager

testMode

open override val testMode: TestMode?

tracker

open override val tracker: suspend (TrackableSuperwallEvent) -> Unit

triggersByEventName

var triggersByEventName: Map<String, Trigger>

unconfirmedAssignments

val unconfirmedAssignments: Map<ExperimentID, Experiment.Variant>

webPaywallRedeemer

open override val webPaywallRedeemer: () -> WebPaywallRedeemer

Functions

delete

open fun delete(storable: Storable<*>)

Delete a value from storage.

effect

open fun effect(action: TypedAction<ConfigContext>)

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

fetchConfiguration

suspend fun fetchConfiguration()

getAssignments

suspend fun getAssignments()

immediate

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

immediateUntil

open suspend fun immediateUntil(action: TypedAction<ConfigContext>, until: (ConfigState) -> Boolean)

persist

open fun <T : Any> persist(storable: Storable<T>, value: T)

Persist a value to storage.

preloadAllPaywalls

suspend fun preloadAllPaywalls()

preloadPaywallsByNames

suspend fun preloadPaywallsByNames(eventNames: Set<String>)

read

open fun <T : Any> read(storable: Storable<T>): Result<T>

recheckPreloadIfNeeded

suspend fun recheckPreloadIfNeeded()

Re-runs preload if any DeviceHelper field referenced by IF_TRUE rules has changed since the last preload. Cheap no-op when (a) config has no IF_TRUE rule or (b) the fingerprint matches the last dispatched preload.

reevaluateTestMode

suspend fun reevaluateTestMode(config: Config? = null, appUserId: String? = null, aliasId: String? = null)

reset

fun reset()

setTriggers

open override fun setTriggers(triggers: Map<String, Trigger>)

sideEffect

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

track

open fun track(event: TrackableSuperwallEvent)

update

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

Apply a state reducer inline.