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

Base Links Screen View Model

abstract class BaseLinksScreenViewModel<L : RefyLink> : RefyScreenViewModel, LinksRetriever<L>

The BaseLinksScreenViewModel class is the support class used to handle the links list displayed by a screen which have to display that links list

Author

N7ghtm4r3 - Tecknobit

Parameters

L

The type of the link to retrieve

See also

Retriever

EquinoxViewModel

RefyScreenViewModel

Inheritors

CustomLinksScreenViewModel

LinksScreenViewModel

Constructors

BaseLinksScreenViewModel

constructor()

Properties

lateinit var keywords: MutableState<String>

keywords the keywords used as filter

open override val linksState: PaginationState<Int, L>

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

abstract fun deleteLink(link: L, onDelete: () -> Unit)

Method to request to delete a link

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 data to retrieve that gone on error during the retrieving

restartRetriever

open override fun restartRetriever()

restartRetrieverIf

open fun restartRetrieverIf(condition: Boolean)

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

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)