core/com.zuko.billingz.core.store.inventory/Inventoryz

Inventoryz

interface Inventoryz : CleanUpz

Blueprint for managing a store's (your applications) entire collection of available products (inventory)

Functions

destroy

@UiThread

abstract fun destroy()

Apply to UI(main thread) dependent classes that require clean-up logic.

getProduct

abstract fun getProduct(sku: String?): Productz?

Search for a specified product by sku id.

getProducts

abstract fun getProducts(type: Productz.Type?, promo: Productz.Promotion?): Map<String, Productz>

Get all available products (in cache), set productType to null to query all products. Available products are validated. Note: the list will be empty if the inventory has not been properly updated.

isReadyLiveData

abstract fun isReadyLiveData(): LiveData<Boolean>

isReadyStateFlow

abstract fun isReadyStateFlow(): StateFlow<Boolean>

Validates if the inventory has collection of verified skus cached in-memory.

queryInventory

abstract fun queryInventory(products: Map<String, Productz.Type>): QueryResult<Map<String, Productz>>

queryProduct

abstract fun queryProduct(sku: String, type: Productz.Type): QueryResult<Productz>

kotlin coroutine function for querying a specific product

updateInventory

abstract fun updateInventory(products: List<Productz>?, type: Productz.Type)

Properties

allProducts

abstract var allProducts: Map<String, Productz.Type>

Current cache of all products that is provided by your app/server. This list may include both verified and unverified skus.

consumables

abstract var consumables: ArrayMap<String, Productz>

Current cache of available consumables.

isNewVersion

abstract var isNewVersion: Boolean

For providing version compatability changes

nonConsumables

abstract var nonConsumables: ArrayMap<String, Productz>

Current cache of available non-consumables.

subscriptions

abstract var subscriptions: ArrayMap<String, Productz>

Current cache of available subscriptions.