jchucomponents-app-updates/com.jeluchu.jchucomponents.appupdates/JchuAppUpdateController

JchuAppUpdateController

class JchuAppUpdateController(activity: ComponentActivity, val config: JchuAppUpdateConfig = JchuAppUpdateConfig()) : DefaultLifecycleObserver

Manages Google Play's flexible in-app update flow for one ComponentActivity.

Create this controller during the activity's onCreate callback. It registers its activity result and observes the activity lifecycle; the host app remains responsible for rendering JchuAppUpdateSnapshot in its own UI.

This controller is opt-in. Set JchuAppUpdateConfig.enabled to false for builds that should not check Google Play for updates.

Constructors

JchuAppUpdateController

constructor(activity: ComponentActivity, config: JchuAppUpdateConfig = JchuAppUpdateConfig())

Properties

config

val config: JchuAppUpdateConfig

snapshot

val snapshot: JchuAppUpdateSnapshot

The latest snapshot, also available before the first update check completes.

snapshots

val snapshots: StateFlow<JchuAppUpdateSnapshot>

Observable snapshots for UI frameworks such as Jetpack Compose.

Functions

dismiss

fun dismiss()

Dismisses the current update UI and applies the configured cooldown to available updates.

installDownloadedUpdate

fun installDownloadedUpdate()

Completes installation after the flexible update has reached JchuAppUpdateState.Downloaded.

onCreate

open fun onCreate(owner: LifecycleOwner)

onDestroy

open override fun onDestroy(owner: LifecycleOwner)

onPause

open fun onPause(owner: LifecycleOwner)

onResume

open override fun onResume(owner: LifecycleOwner)

onStart

open override fun onStart(owner: LifecycleOwner)

onStop

open override fun onStop(owner: LifecycleOwner)

retry

fun retry()

Checks again and requests that an available update be presented even if recently dismissed.

showDetails

fun showDetails()

Reopens the app's update UI for an update that is still in progress.

startFlexibleUpdate

fun startFlexibleUpdate()

Starts the flexible update flow for the latest available update.