Refy/com.tecknobit.refy.ui.screens.collection.presentation/CollectionScreenViewModel

Collection Screen View Model

class CollectionScreenViewModel(collectionId: String, collectionName: String, collectionColor: String) : ItemScreenViewModel<LinksCollection> , LinksRetriever<RefyLink.RefyLinkImpl> , CollectionsManager

The CollectionScreenViewModel class is the support class used by the com.tecknobit.refy.ui.screens.collection.presenter.CollectionScreen

Author

N7ghtm4r3 - Tecknobit

Parameters

collectionId

The identifier of the collection

collectionName

The name of the collection

collectionColor

The color of the collection

See also

Retriever

EquinoxViewModel

RefyScreenViewModel

ItemScreenViewModel

CollectionsManager

Constructors

CollectionScreenViewModel

constructor(collectionId: String, collectionName: String, collectionColor: String)

Properties

collectionTeams

val collectionTeams: PaginationState<Int, Team>

collectionTeams the state used to handle the pagination of the teams where the collection is shared

val color: StateFlow<Color>

val item: StateFlow<LinksCollection?>

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

open override val requestsScope: CoroutineScope

requestsScope the CoroutineScope used to make the requests to the backend

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)

open fun attachLinks(collection: LinksCollection, links: List<RefyLink.RefyLinkImpl>, afterAttached: () -> Unit)

Method to request to attach links to the collection

canRetrieverStart

open override fun canRetrieverStart(): Boolean

continueToRetrieve

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

deleteCollection

open fun deleteCollection(collection: LinksCollection, onDelete: () -> Unit)

Method to delete the collection

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

open override 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

refreshAfterLinksAttached

open override fun refreshAfterLinksAttached()

Method to refresh the data after the links have been attached

refreshAfterTeamsSharing

open override fun refreshAfterTeamsSharing()

Method to refresh the data after the collection has been shared with teams

open override fun reload()

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

open override fun removeLink(link: RefyLink.RefyLinkImpl)

Method to remove a link contained by the _item

fun removeTeam(team: Team)

Method to remove a team from the collection

restartRetriever

open override fun restartRetriever()

restartRetrieverIf

open fun restartRetrieverIf(condition: Boolean)

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

open override fun retrieveItem()

Method to retrieve the information of the item to display

setActiveContext

open fun setActiveContext(currentContext: KClass<*>)

open fun shareWithTeams(collection: LinksCollection, teams: List<Team>, afterShared: () -> Unit)

Method to request to share the collection with teams

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)