mobile/android/fenix/app/src/main/java/org/mozilla/fenix/components/menu/store/MenuAction.kt

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 package org.mozilla.fenix.components.menu.store
   6
   7 import mozilla.components.lib.state.Action
   8
   9 /**
  10  * Actions to dispatch through the [MenuStore] to modify the [MenuState].
  11  */
  12 sealed class MenuAction : Action {
  13
  14     /**
  15      * Updates whether or not the current selected tab is bookmarked.
  16      *
  17      * @property isBookmarked Whether or not the current selected is bookmarked.
  18      */
  19     data class UpdateBookmarked(val isBookmarked: Boolean) : MenuAction()
  20
  21     /**
  22      * [MenuAction] dispatched when a navigation event occurs for a specific destination.
  23      */
  24     sealed class Navigate : MenuAction() {
  25
  26         /**
  27          * [Navigate] action dispatched when navigating to the settings.
  28          */
  29         data object Settings : Navigate()
  30     }
  31 }