Custom Link Screen View Model

class CustomLinkScreenViewModel(snackbarHostState: SnackbarHostState, initialCustomLink: CustomRefyLink) : LinksViewModelHelper<CustomRefyLink> , RecompositionsLocker

The CustomLinkScreenViewModel class is the support class used by CustomLinkScreen to communicate with the backend and to execute the refreshing routines to update the UI data and working with the CustomRefyLink

Author

N7ghtm4r3 - Tecknobit

Parameters

snackbarHostState

: the host to launch the snackbar messages

initialCustomLink

: the initial value of the CustomRefyLink

See also

ViewModel
FetcherManagerWrapper
EquinoxViewModel

Constructors

Link copied to clipboard
constructor(snackbarHostState: SnackbarHostState, initialCustomLink: CustomRefyLink)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val customLink: StateFlow<CustomRefyLink>

Functions

Link copied to clipboard
open fun addCloseable(closeable: AutoCloseable)
fun addCloseable(key: String, closeable: AutoCloseable)
Link copied to clipboard
open override fun canRefresherStart(): Boolean
Link copied to clipboard
open override fun continueToFetch(currentContext: Class<*>): Boolean
Link copied to clipboard
open override fun deleteLink(link: CustomRefyLink, onSuccess: () -> Unit)

Function to execute the request to delete a link

Link copied to clipboard
open override fun execRefreshingRoutine(currentContext: Class<*>, routine: () -> Unit, repeatRoutine: Boolean, refreshDelay: Long)
Link copied to clipboard
Link copied to clipboard
open fun lastCanGoes(counter: Int): Boolean

Function to decree if the counter value reached the threshold of the LAST_CAN_GOES_VALUE

Link copied to clipboard

Function to execute the request to refresh the custom link displayed

Link copied to clipboard
open override fun reset()

Function to reset the counter to zero

Link copied to clipboard
open override fun restartRefresher()
Link copied to clipboard
open fun setActiveContext(currentContext: Class<*>)
Link copied to clipboard
fun setCurrentUserOwnedCollections(forceRefresh: Boolean = false)

Function to execute the request to fetch only the collections owned by the localUser, the collections fetched will be set to localUser.collections

Link copied to clipboard
fun setCurrentUserOwnedLinks(forceRefresh: Boolean = false)

Function to execute the request to fetch only the links owned by the localUser, the links fetched will be set to localUser.links

Link copied to clipboard
fun setCurrentUserOwnedTeams(forceRefresh: Boolean = false)

Function to execute the request to fetch only the teams owned by the localUser, the teams fetched will be set to localUser.teams

Link copied to clipboard
open override fun suspendRefresher()
Link copied to clipboard
fun SuspendUntilElementOnScreen(elementVisible: MutableState<Boolean>)