You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
4.3 KiB
Kotlin
74 lines
4.3 KiB
Kotlin
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
package org.mozilla.fenix.components.appstate
|
|
|
|
import mozilla.components.concept.storage.BookmarkNode
|
|
import mozilla.components.feature.tab.collections.TabCollection
|
|
import mozilla.components.feature.top.sites.TopSite
|
|
import mozilla.components.lib.crash.Crash.NativeCodeCrash
|
|
import mozilla.components.lib.state.State
|
|
import mozilla.components.service.pocket.PocketStory
|
|
import mozilla.components.service.pocket.PocketStory.PocketRecommendedStory
|
|
import mozilla.components.service.pocket.PocketStory.PocketSponsoredStory
|
|
import org.mozilla.fenix.gleanplumb.MessagingState
|
|
import org.mozilla.fenix.home.HomeFragment
|
|
import org.mozilla.fenix.home.Mode
|
|
import org.mozilla.fenix.home.pocket.PocketRecommendedStoriesCategory
|
|
import org.mozilla.fenix.home.pocket.PocketRecommendedStoriesSelectedCategory
|
|
import org.mozilla.fenix.home.recentbookmarks.RecentBookmark
|
|
import org.mozilla.fenix.home.recentsyncedtabs.RecentSyncedTabState
|
|
import org.mozilla.fenix.home.recenttabs.RecentTab
|
|
import org.mozilla.fenix.home.recentvisits.RecentlyVisitedItem
|
|
import org.mozilla.fenix.library.history.PendingDeletionHistory
|
|
import org.mozilla.fenix.wallpapers.WallpaperState
|
|
|
|
/**
|
|
* Value type that represents the state of the tabs tray.
|
|
*
|
|
* @property inactiveTabsExpanded A flag to know if the Inactive Tabs section of the Tabs Tray
|
|
* should be expanded when the tray is opened.
|
|
* @property firstFrameDrawn Flag indicating whether the first frame of the homescreen has been drawn.
|
|
* @property nonFatalCrashes List of non-fatal crashes that allow the app to continue being used.
|
|
* @property collections The list of [TabCollection] to display in the [HomeFragment].
|
|
* @property expandedCollections A set containing the ids of the [TabCollection] that are expanded
|
|
* in the [HomeFragment].
|
|
* @property mode The state of the [HomeFragment] UI.
|
|
* @property topSites The list of [TopSite] in the [HomeFragment].
|
|
* @property showCollectionPlaceholder If true, shows a placeholder when there are no collections.
|
|
* @property recentTabs The list of recent [RecentTab] in the [HomeFragment].
|
|
* @property recentSyncedTabState The [RecentSyncedTabState] in the [HomeFragment].
|
|
* @property recentBookmarks The list of recently saved [BookmarkNode]s to show on the [HomeFragment].
|
|
* @property recentHistory The list of [RecentlyVisitedItem]s.
|
|
* @property pocketStories The list of currently shown [PocketRecommendedStory]s.
|
|
* @property pocketStoriesCategories All [PocketRecommendedStory] categories.
|
|
* @property pocketStoriesCategoriesSelections Current Pocket recommended stories categories selected by the user.
|
|
* @property pocketSponsoredStories All [PocketSponsoredStory]s.
|
|
* @property messaging State related messages.
|
|
* @property pendingDeletionHistoryItems The set of History items marked for removal in the UI,
|
|
* awaiting to be removed once the Undo snackbar hides away.
|
|
* Also serves as an in memory cache of all stories mapped by category allowing for quick stories filtering.
|
|
*/
|
|
data class AppState(
|
|
val inactiveTabsExpanded: Boolean = false,
|
|
val firstFrameDrawn: Boolean = false,
|
|
val nonFatalCrashes: List<NativeCodeCrash> = emptyList(),
|
|
val collections: List<TabCollection> = emptyList(),
|
|
val expandedCollections: Set<Long> = emptySet(),
|
|
val mode: Mode = Mode.Normal,
|
|
val topSites: List<TopSite> = emptyList(),
|
|
val showCollectionPlaceholder: Boolean = false,
|
|
val recentTabs: List<RecentTab> = emptyList(),
|
|
val recentSyncedTabState: RecentSyncedTabState = RecentSyncedTabState.None,
|
|
val recentBookmarks: List<RecentBookmark> = emptyList(),
|
|
val recentHistory: List<RecentlyVisitedItem> = emptyList(),
|
|
val pocketStories: List<PocketStory> = emptyList(),
|
|
val pocketStoriesCategories: List<PocketRecommendedStoriesCategory> = emptyList(),
|
|
val pocketStoriesCategoriesSelections: List<PocketRecommendedStoriesSelectedCategory> = emptyList(),
|
|
val pocketSponsoredStories: List<PocketSponsoredStory> = emptyList(),
|
|
val messaging: MessagingState = MessagingState(),
|
|
val pendingDeletionHistoryItems: Set<PendingDeletionHistory> = emptySet(),
|
|
val wallpaperState: WallpaperState = WallpaperState.default,
|
|
) : State
|