Refy/com.tecknobit.refy.viewmodels.collections/CollectionScreenViewModel

Collection Screen View Model

class CollectionScreenViewModel(snackbarHostState: SnackbarHostState, val initialCollection: LinksCollection) : LinksCollectionViewModelHelper, RecompositionsLocker

The CollectionScreenViewModel class is the support class used by CollectionScreen to communicate with the backend and to execute the refreshing routines to update the UI data and working with the LinksCollection

Author

N7ghtm4r3 - Tecknobit

Parameters

snackbarHostState

: the host to launch the snackbar messages

initialCollection

: the initial value of the LinksCollection

See also

ViewModel

FetcherManager.FetcherManagerWrapper

EquinoxViewModel

RefyViewModel

LinksCollectionViewModelHelper

Constructors

CollectionScreenViewModel

constructor(snackbarHostState: SnackbarHostState, initialCollection: LinksCollection)

Types

object Companion

Properties

val collection: StateFlow<LinksCollection>

initialCollection

val initialCollection: LinksCollection

Functions

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

addLinksToCollection

fun addLinksToCollection(collection: LinksCollection, links: List<String>, onSuccess: () -> Unit)

Function to execute the request to add links to a collection

addTeamsToCollection

fun addTeamsToCollection(collection: LinksCollection, teams: List<String>, onSuccess: () -> Unit)

Function to execute the request to share a collection with teams

canRefresherStart

open override fun canRefresherStart(): Boolean

continueToFetch

open override fun continueToFetch(currentContext: Class<*>): Boolean

deleteCollection

fun deleteCollection(collection: LinksCollection, onSuccess: () -> Unit)

Function to execute the request to delete a collection

execRefreshingRoutine

open override fun execRefreshingRoutine(currentContext: Class<*>, routine: () -> Unit, repeatRoutine: Boolean, refreshDelay: Long)

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

open fun lastCanGoes(counter: Int): Boolean

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

refreshCollection

fun refreshCollection()

Function to execute the request to refresh the collection displayed

removeLinkFromCollection

fun removeLinkFromCollection(link: RefyLink)

Function to execute the request to remove from the collection a link

open override fun reset()

Function to reset the counter to zero

restartRefresher

open override fun restartRefresher()

setActiveContext

open fun setActiveContext(currentContext: Class<*>)

setCurrentUserOwnedCollections

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

setCurrentUserOwnedLinks

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

setCurrentUserOwnedTeams

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

suspendRefresher

open override fun suspendRefresher()

SuspendUntilElementOnScreen

fun SuspendUntilElementOnScreen(elementVisible: MutableState<Boolean>)