viewmodel/com.hoc081098.kmp.viewmodel/ViewModel

ViewModel

actual abstract class ViewModel : ViewModel

expect abstract class ViewModel

The ViewModel class is a business logic or screen level state holder. It exposes state to the UI and encapsulates related business logic. Its principal advantage is that it caches state and persists it through configuration changes (on Android).

actual abstract class ViewModel

Constructors

ViewModel

actual constructor()

expect constructor()

Construct a new ViewModel instance.

expect constructor(vararg closeables: Closeable)

Construct a new ViewModel instance. Any Closeable objects provided here will be closed directly before onCleared is called.

actual constructor()

actual constructor(vararg closeables: Closeable)

Properties

viewModelScope

actual val viewModelScope: CoroutineScope

expect val viewModelScope: CoroutineScope

CoroutineScope tied to this ViewModel. This scope will be canceled when ViewModel will be cleared, i.e ViewModel.onCleared is called.

actual val viewModelScope: CoroutineScope

Functions

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

expect fun addCloseable(closeable: Closeable)

Add a new Closeable object that will be closed directly before onCleared is called.

actual fun addCloseable(closeable: Closeable)

clear

fun clear()

When using it on non Android platforms (eg. iOS, macOS, ...) you'll want to make sure that you call clear on your ViewModel on deinit to properly cancel the CoroutineScope.

getCloseable

fun <T : AutoCloseable> getCloseable(key: String): T?

isCleared

@InternalKmpViewModelApi

fun isCleared(): Boolean

Returns true if this ViewModel has been cleared.