viewmodel/com.hoc081098.kmp.viewmodel

Package-level declarations

Types

Link copied to clipboard
actual typealias Closeable = java.io.Closeable
expect fun interface Closeable
actual fun interface Closeable
actual typealias Closeable = java.io.Closeable
actual fun interface Closeable
Link copied to clipboard
actual typealias CreationExtras = androidx.lifecycle.viewmodel.CreationExtras
expect abstract class CreationExtras

Simple map-like object that passed in ViewModelFactory.create to provide an additional information to a factory.

actual abstract class CreationExtras
Link copied to clipboard
actual typealias CreationExtrasKey<T> = CreationExtras.Key<T>
expect interface CreationExtrasKey<T>

Key for the elements of CreationExtras. T is a type of an element with this key.

actual interface CreationExtrasKey<T>
Link copied to clipboard
actual typealias EmptyCreationExtras = CreationExtras.Empty
expect object EmptyCreationExtras : CreationExtras

Empty CreationExtras.

actual object EmptyCreationExtras : CreationExtras
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
annotation class InternalKmpViewModelApi

Code marked with InternalKmpViewModelApi has no guarantees about API stability and can be changed at any time.

Link copied to clipboard
actual typealias MainThread = androidx.annotation.MainThread
@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER])
expect annotation class MainThread

Denotes that the annotated method should only be called on the main thread. If the annotated element is a class, then all methods in the class should be called on the main thread.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER])
actual annotation class MainThread
Link copied to clipboard
Link copied to clipboard
actual class MutableCreationExtrasBuilder

With Kotlin 1.9.20, an expect with default arguments are no longer permitted when an actual is a typealias (see KT-57614), we cannot use actual typealias MutableCreationExtras = androidx.lifecycle.viewmodel.MutableCreationExtras. So we have to use wrapper class instead.

expect class MutableCreationExtrasBuilder(initialExtras: CreationExtras = EmptyCreationExtras)

Mutable builder for CreationExtras.

actual class MutableCreationExtrasBuilder(initialExtras: CreationExtras) : CreationExtras
Link copied to clipboard
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
Link copied to clipboard
interface ViewModelFactory<VM : ViewModel>

Implementations of Factory interface are responsible to instantiate ViewModels.

Link copied to clipboard
actual open class ViewModelStore
expect open class ViewModelStore

Class to store ViewModels.

actual open class ViewModelStore
Link copied to clipboard
interface ViewModelStoreOwner

A scope that owns ViewModelStore.

Properties

Link copied to clipboard
actual val VIEW_MODEL_KEY: Key<String>
expect val VIEW_MODEL_KEY: Key<String>

A CreationExtrasKey to get a key associated with a requested ViewModel from CreationExtras.

@JvmField
actual val VIEW_MODEL_KEY: Key<String>

Functions

Link copied to clipboard
inline fun buildCreationExtras(initialExtras: CreationExtras = EmptyCreationExtras, builderAction: MutableCreationExtrasBuilder.() -> Unit): CreationExtras

Builds a CreationExtras by populating a MutableCreationExtrasBuilder using the given builderAction. initialExtras will be copied into the resulting MutableCreationExtrasBuilder first. Then the builderAction will be applied to the MutableCreationExtrasBuilder.

Link copied to clipboard
inline fun CreationExtras.edit(builderAction: MutableCreationExtrasBuilder.() -> Unit): CreationExtras

Edits this CreationExtras by populating a MutableCreationExtrasBuilder using the given builderAction. Content of this CreationExtras will be copied into the resulting MutableCreationExtrasBuilder first. Then the builderAction will be applied to the MutableCreationExtrasBuilder.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <VM : ViewModel> viewModelFactory(crossinline builder: CreationExtras.() -> VM): ViewModelFactory<VM>
inline fun <VM : ViewModel> viewModelFactory(viewModelClass: KClass<VM>, crossinline builder: CreationExtras.() -> VM): ViewModelFactory<VM>

Creates a ViewModelFactory that returns the result of invoking builder.