Superwall Android SDK/com.superwall.sdk.store/Entitlements

Entitlements

class Entitlements(val storage: Storage, actorScope: CoroutineScope = CoroutineScope(Dispatchers.Default), val actor: StateActor<EntitlementsContext, EntitlementsState> = StateActor(createInitialEntitlementsState(storage), actorScope), val tracker: suspend (TrackableSuperwallEvent) -> Unit = {}) : EntitlementsContext(source)

Facade over the entitlements state held in a StateActor.

Implements EntitlementsContext directly — actions receive this as their context, eliminating the intermediate object.

State mutations use StateActor.update (synchronous CAS, routed through interceptors) and are persisted immediately through persist. The initial state is rebuilt from storage by createInitialEntitlementsState before the actor starts, so cached status, product entitlements and web entitlements are available synchronously after construction.

Constructors

constructor(storage: Storage, actorScope: CoroutineScope = CoroutineScope(Dispatchers.Default), actor: StateActor<EntitlementsContext, EntitlementsState> = StateActor(createInitialEntitlementsState(storage), actorScope), tracker: suspend (TrackableSuperwallEvent) -> Unit = {})

Properties

val active: Set<Entitlement>

The active entitlements. Uses mergeEntitlementsPrioritized to deduplicate entitlements by ID, keeping the highest priority version of each and merging productIds.

open override val actor: StateActor<EntitlementsContext, EntitlementsState>

val all: Set<Entitlement>

All entitlements, regardless of whether they're active or not. Includes web entitlements from the latest redemption response.

entitlementsByProductId

val entitlementsByProductId: Map<String, Set<Entitlement>>

Returns a snapshot of all entitlements by product ID. Used when loading purchases to enrich entitlements with transaction data.

val inactive: Set<Entitlement>

The inactive entitlements.

open override val scope: CoroutineScope

open override val state: StateFlow<EntitlementsState>

Delegate state reads to the actor.

val status: StateFlow<SubscriptionStatus>

A StateFlow of the entitlement status of the user. Set this using Superwall.instance.setEntitlementStatus.

open override val storage: Storage

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

val web: Set<Entitlement>

Active web entitlements from the latest redemption response. Updated by WebPaywallRedeemer through setWebEntitlements.

Functions

fun byProductIds(ids: Set<String>): Set<Entitlement>

Returns a Set of Entitlements belonging to given product IDs.

open fun delete(storable: Storable<*>)

Delete a value from storage.

open fun effect(action: TypedAction<EntitlementsContext>)

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

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

open suspend fun immediateUntil(action: TypedAction<EntitlementsContext>, until: (EntitlementsState) -> Boolean)

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

Persist a value to storage.

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

setSubscriptionStatus

fun setSubscriptionStatus(value: SubscriptionStatus)

Sets the entitlement status and updates the corresponding entitlement collections.

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

open fun track(event: TrackableSuperwallEvent)

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

Apply a state reducer inline.