Refy/com.tecknobit.refy.ui.shared.presentations/ItemScreenViewModel

Item Screen View Model

abstract class ItemScreenViewModel<I : RefyItem>(itemId: String, name: String) : RefyScreenViewModel, LinksRetriever<RefyLink.RefyLinkImpl>

The ItemScreenViewModel class is the support class used by the screens which have to display the details of a RefyItem or manage it

Author

N7ghtm4r3 - Tecknobit

Parameters

itemId

The identifier of the item

name

The name of the item

I

The type of the item displayed

See also

Retriever

EquinoxViewModel

RefyScreenViewModel

Inheritors

CollectionScreenViewModel

TeamScreenViewModel

Constructors

ItemScreenViewModel

constructor(itemId: String, name: String)

Properties

val item: StateFlow<I?>

val itemName: StateFlow<String>

lateinit var keywords: MutableState<String>

keywords the keywords used as filter

open override val linksState: PaginationState<Int, RefyLink.RefyLinkImpl>

linksState the state used to handle the pagination of the links list

sessionFlowState

open lateinit override var sessionFlowState: SessionFlowState

sessionFlowState the state used to manage the session lifecycle in the screen

snackbarHostState

val snackbarHostState: SnackbarHostState?

Functions

expect open fun addCloseable(closeable: AutoCloseable)

expect fun addCloseable(key: String, closeable: AutoCloseable)

canRetrieverStart

open override fun canRetrieverStart(): Boolean

continueToRetrieve

open override fun continueToRetrieve(currentContext: KClass<*>): Boolean

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

abstract fun loadLinks(page: Int)

Method used to load and retrieve the links to append to the linksState

notifyServerOffline

open fun notifyServerOffline()

performOnServerOffline

open override fun performOnServerOffline()

Routine to perform when the server is currently offline

open override fun refresh()

Method used to refresh the data displayed by the screen

open override fun reload()

Method used to reload the content related to the _item when an error occurred during its retrieving

abstract fun removeLink(link: RefyLink.RefyLinkImpl)

Method to remove a link contained by the _item

restartRetriever

open override fun restartRetriever()

restartRetrieverIf

open fun restartRetrieverIf(condition: Boolean)

open override fun retrieve(currentContext: KClass<*>, routine: suspend () -> Unit, repeatRoutine: Boolean, refreshDelay: Long)

abstract fun retrieveItem()

Method to retrieve the information of the item to display

setActiveContext

open fun setActiveContext(currentContext: KClass<*>)

showSnackbarMessage

fun showSnackbarMessage(message: String, actionLabel: String?, onDismiss: () -> Unit?, onActionPerformed: () -> Unit?, withDismissAction: Boolean, duration: SnackbarDuration)

fun showSnackbarMessage(response: JsonObject, actionLabel: String?, onDismiss: () -> Unit?, onActionPerformed: () -> Unit?, withDismissAction: Boolean, duration: SnackbarDuration)

fun showSnackbarMessage(message: StringResource, actionLabel: StringResource?, onDismiss: () -> Unit?, onActionPerformed: () -> Unit?, withDismissAction: Boolean, duration: SnackbarDuration)

suspendRetriever

open override fun suspendRetriever()

suspendRetrieverIf

open fun suspendRetrieverIf(condition: Boolean)