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

Entitlements

class Entitlements(storage: Storage, scope: CoroutineScope = CoroutineScope(Dispatchers.Default))(source)

A class that handles the Set of Entitlement objects retrieved from the Superwall dashboard.

Constructors

Entitlements

constructor(storage: Storage, scope: CoroutineScope = CoroutineScope(Dispatchers.Default))

Properties

active

val active: Set<Entitlement>

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

all

val all: Set<Entitlement>

All entitlements, regardless of whether they're active or not.

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.

inactive

val inactive: Set<Entitlement>

The inactive entitlements.

status

val status: StateFlow<SubscriptionStatus>

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

web

val web: Set<Entitlement>

Functions

byProductIds

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

Returns a Set of Entitlements belonging to given product IDs.

setSubscriptionStatus

fun setSubscriptionStatus(value: SubscriptionStatus)

Sets the entitlement status and updates the corresponding entitlement collections.