From d6909d5a530617ad529948ed5995394637417039 Mon Sep 17 00:00:00 2001
From: Brian Yencho <brian@livefront.com>
Date: Thu, 21 Dec 2023 10:48:32 -0600
Subject: [PATCH] Add clarifying documentation to various StateFlows (#430)
---
.../data/vault/repository/VaultRepository.kt | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/repository/VaultRepository.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/repository/VaultRepository.kt
index 783d181a3..560d9734b 100644
--- a/app/src/main/java/com/x8bit/bitwarden/data/vault/repository/VaultRepository.kt
+++ b/app/src/main/java/com/x8bit/bitwarden/data/vault/repository/VaultRepository.kt
@@ -21,21 +21,33 @@ interface VaultRepository {
/**
* Flow that represents the current vault data.
+ *
+ * Note that the [StateFlow.value] will return the last known value but the [StateFlow] itself
+ * must be collected in order to trigger state changes.
*/
val vaultDataStateFlow: StateFlow<DataState<VaultData>>
/**
* Flow that represents all ciphers for the active user.
+ *
+ * Note that the [StateFlow.value] will return the last known value but the [StateFlow] itself
+ * must be collected in order to trigger state changes.
*/
val ciphersStateFlow: StateFlow<DataState<List<CipherView>>>
/**
* Flow that represents all collections for the active user.
+ *
+ * Note that the [StateFlow.value] will return the last known value but the [StateFlow] itself
+ * must be collected in order to trigger state changes.
*/
val collectionsStateFlow: StateFlow<DataState<List<CollectionView>>>
/**
* Flow that represents all folders for the active user.
+ *
+ * Note that the [StateFlow.value] will return the last known value but the [StateFlow] itself
+ * must be collected in order to trigger state changes.
*/
val foldersStateFlow: StateFlow<DataState<List<FolderView>>>