Superwall Android SDK/com.superwall.sdk.store.testmode/TestMode

TestMode

class TestMode(val storage: Storage, val isTestEnvironment: Boolean = Companion.isTestEnvironment, val getSuperwallProducts: suspend () -> Either<SuperwallProductsResponse, NetworkError> = { Either.Failure(NetworkError.Unknown()) }, val entitlements: Entitlements? = null, val activityProvider: () -> ActivityProvider? = { null }, val activityTracker: () -> CurrentActivityTracker? = { null }, val hasExternalPurchaseController: () -> Boolean = { false }, val apiKey: () -> String = { "" }, val dashboardBaseUrl: () -> String = { "" }, val tracker: suspend (TrackableSuperwallEvent) -> Unit = { }, val showModal: suspend (activity: Activity, reason: String, hasPurchaseController: Boolean, availableEntitlements: List<String>, apiKey: String, dashboardBaseUrl: String, savedSettings: TestModeSettings?) -> TestModeModalResult = { activity, reason, hasPC, available, ak, db, saved -> TestModeModal.show(activity, reason, hasPC, available, ak, db, saved) }, ioScope: CoroutineScope = IOScope(), val actor: StateActor<TestModeContext, TestModeState> = SequentialActor(TestModeState.Inactive, ioScope)) : TestModeContext(source)

Test-mode manager.

Implements TestModeContext directly so TestModeState.Actions receive this as their receiver — same pattern as com.superwall.sdk.identity.IdentityManager / com.superwall.sdk.identity.IdentityContext.

State is held in a SequentialActor; pure mutations go through update(Updates.X) (CAS-atomic), async work (network + modal) is dispatched as TestModeState.Actions.

Constructors

TestMode

constructor(storage: Storage, isTestEnvironment: Boolean = Companion.isTestEnvironment, getSuperwallProducts: suspend () -> Either<SuperwallProductsResponse, NetworkError> = { Either.Failure(NetworkError.Unknown()) }, entitlements: Entitlements? = null, activityProvider: () -> ActivityProvider? = { null }, activityTracker: () -> CurrentActivityTracker? = { null }, hasExternalPurchaseController: () -> Boolean = { false }, apiKey: () -> String = { "" }, dashboardBaseUrl: () -> String = { "" }, tracker: suspend (TrackableSuperwallEvent) -> Unit = { }, showModal: suspend (activity: Activity, reason: String, hasPurchaseController: Boolean, availableEntitlements: List<String>, apiKey: String, dashboardBaseUrl: String, savedSettings: TestModeSettings?) -> TestModeModalResult = { activity, reason, hasPC, available, ak, db, saved -> TestModeModal.show(activity, reason, hasPC, available, ak, db, saved) }, ioScope: CoroutineScope = IOScope(), actor: StateActor<TestModeContext, TestModeState> = SequentialActor(TestModeState.Inactive, ioScope))

Types

Companion

object Companion

Properties

activityProvider

open override val activityProvider: () -> ActivityProvider?

activityTracker

open override val activityTracker: () -> CurrentActivityTracker?

actor

open override val actor: StateActor<TestModeContext, TestModeState>

apiKey

open override val apiKey: () -> String

dashboardBaseUrl

open override val dashboardBaseUrl: () -> String

entitlements

open override val entitlements: Entitlements?

freeTrialOverride

val freeTrialOverride: FreeTrialOverride

getSuperwallProducts

open override val getSuperwallProducts: suspend () -> Either<SuperwallProductsResponse, NetworkError>

hasExternalPurchaseController

open override val hasExternalPurchaseController: () -> Boolean

isTestEnvironment

open override val isTestEnvironment: Boolean

isTestMode

val isTestMode: Boolean

overriddenSubscriptionStatus

val overriddenSubscriptionStatus: SubscriptionStatus?

products

val products: List<SuperwallProduct>

scope

open override val scope: CoroutineScope

showModal

open override val showModal: suspend (activity: Activity, reason: String, hasPurchaseController: Boolean, availableEntitlements: List<String>, apiKey: String, dashboardBaseUrl: String, savedSettings: TestModeSettings?) -> TestModeModalResult

state

open override val state: StateFlow<TestModeState>

Delegate state reads to the actor.

storage

open override val storage: Storage

testEntitlementIds

val testEntitlementIds: Set<String>

testEntitlementSelections

val testEntitlementSelections: List<EntitlementSelection>

testModeReason

val testModeReason: TestModeReason?

tracker

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

Functions

activate

suspend fun activate(config: Config, justActivated: Boolean)

Refresh the test product catalog and (when justActivated) present the modal. Runs as a TestModeState.Actions.Activate action and suspends until it completes, so callers that must not wait on the modal's blocking UI (e.g. ConfigState) launch it in their own scope.

allEntitlements

fun allEntitlements(): Set<String>

awaitTestProducts

suspend fun awaitTestProducts(timeout: Duration = 5.seconds)

Suspend until the test product catalog has been loaded (or timeout elapses). No-op when inactive.

buildSubscriptionStatus

fun buildSubscriptionStatus(): SubscriptionStatus

clearSettings

fun clearSettings()

clearTestModeState

fun clearTestModeState()

delete

open fun delete(storable: Storable<*>)

Delete a value from storage.

effect

open fun effect(action: TypedAction<TestModeContext>)

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

entitlementsForProduct

fun entitlementsForProduct(product: SuperwallProduct): List<SuperwallEntitlementRef>

evaluateTestMode

fun evaluateTestMode(config: Config, bundleId: String, appUserId: String?, aliasId: String?, testModeBehavior: TestModeBehavior = TestModeBehavior.AUTOMATIC)

fakePurchase