Brownie/com.tecknobit.brownie.ui.screens.host.presentation/HostScreenViewModel

Host Screen View Model

class HostScreenViewModel(hostId: String) : EquinoxViewModel, HostManager

The HostScreenViewModel class is the support class used by the com.tecknobit.brownie.ui.screens.host.presenter.HostScreen screen

Author

N7ghtm4r3 - Tecknobit

See also

Retriever

EquinoxViewModel

Constructors

HostScreenViewModel

constructor(hostId: String)

Properties

val hostOverview: StateFlow<SavedHostOverview?>

refreshingServices

val refreshingServices: SharedFlow<Boolean>

open override var requestsScope: CoroutineScope

requestsScope the CoroutineScope used to make the requests to the backend

lateinit var servicesQuery: MutableState<String>

servicesQuery the query used to filter the services

val servicesState: PaginationState<Int, HostService>

servicesState the state used to handle the pagination of the services

sessionFlowState

lateinit var sessionFlowState: SessionFlowState

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

snackbarHostState

val snackbarHostState: SnackbarHostState?

val statusFilters: SnapshotStateList<ServiceStatus>

statusFilters the list of the statuses used to filter the hosts result

Functions

expect open fun addCloseable(closeable: AutoCloseable)

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

fun applyFilters(onApply: () -> Unit)

Method used to apply the selected statuses and refresh the current servicesState list

canRetrieverStart

open override fun canRetrieverStart(): Boolean

fun clearFilters(onClear: () -> Unit)

Method to clear the current set filters

continueToRetrieve

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

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

handleHostStatus

open fun handleHostStatus(host: SavedHost, onStatusChange: (HostStatus) -> Unit)

Method used to handle the status of the host such online or offline

handleServiceStatus

fun handleServiceStatus(service: HostService, onStatusChange: (ServiceStatus) -> Unit)

Method used to handle the status of the service such running or stopped

open fun rebootHost(host: SavedHost, onStatusChange: () -> Unit)

Method used to reboot a host

fun rebootService(service: HostService, onStatusChange: () -> Unit)

Method used to reboot a service

restartRetriever

open override fun restartRetriever()

restartRetrieverIf

open fun restartRetrieverIf(condition: Boolean)

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

retrieveHostOverview

fun retrieveHostOverview()

Method used to retrieve the current host overview data

setActiveContext

open fun setActiveContext(currentContext: KClass<*>)

open override fun showFailure(error: JsonObject)

Method used to display an eventual occurred error

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)

open fun unregisterHost(host: SavedHost, onSuccess: () -> Unit)

Method used to unregister a host from the session