Actions Reference


                    
                    
                    ScreenAction

A protocol representing the navigation action that is performed in the screen container.

Declaration

Swift

public protocol ScreenAction


                    
                    
                    ScreenActionStorage

Undocumented

Declaration

Swift

public final class ScreenActionStorage<State>


                    
                    
                    AnyScreenAction

An action that performs type erasure by wrapping another action.

AnyScreenAction is a concrete implementation of ScreenAction that has no significant properties of its own, and passes through elements from its wrapped action.

Use AnyScreenAction to wrap an actions whose type has details you don’t want to expose across API boundaries, such as different modules. When you use type erasure this way, you can change the underlying acrtion implementation over time without affecting existing clients.

You can use eraseToAnyAction() and eraseToAnyVoidAction()methods to wrap an action with AnyScreenAction.

Declaration

Swift

public struct AnyScreenAction<Container: ScreenContainer, Output>:
    ScreenAction,
    CustomStringConvertible


                    
                    
                    ScreenFailAction

Undocumented

Declaration

Swift

public struct ScreenFailAction<Container> : ScreenAction where Container : ScreenContainer


                    
                    
                    ScreenFoldAction

Performs a nested action in the container that will be retrieved by performing another action.

Declaration

Swift

public struct ScreenFoldAction<
    Action: ScreenAction,
    Nested: ScreenAction
>: ScreenAction where Action.Output == Nested.Container


                    
                    
                    ScreenFromAction

Undocumented

Declaration

Swift

public struct ScreenFromAction<
    Container: ScreenContainer,
    Output: ScreenContainer
>: ScreenAction


                    
                    
                    ScreenGetAction

Undocumented

Declaration

Swift

public struct ScreenGetAction<Container> : ScreenAction where Container : ScreenContainer


                    
                    
                    ScreenMakeVisibleAction

Undocumented

Declaration

Swift

public struct ScreenMakeVisibleAction<Container> : ScreenAction where Container : UIViewController


                    
                    
                    ScreenNavigateAction

Performs a set of actions.

Declaration

Swift

public struct ScreenNavigateAction<Container> : ScreenAction where Container : ScreenContainer


                    
                    
                    ScreenWaitAction

Waits for a given time interval.

Declaration

Swift

public struct ScreenWaitAction<Container> : ScreenAction where Container : ScreenContainer


                    
                    
                    ScreenPredicate

Undocumented

Declaration

Swift

public struct ScreenPredicate<Container> : CustomStringConvertible where Container : ScreenContainer


                    
                    
                    ScreenFirstAction

Undocumented

Declaration

Swift

public struct ScreenFirstAction<
    Container: ScreenContainer,
    Output: ScreenContainer
>: ScreenAction


                    
                    
                    ScreenLastAction

Undocumented

Declaration

Swift

public struct ScreenLastAction<
    Container: ScreenContainer,
    Output: ScreenContainer
>: ScreenAction


                    
                    
                    ScreenTopAction

Undocumented

Declaration

Swift

public struct ScreenTopAction<
    Container: ScreenContainer,
    Output: ScreenContainer
>: ScreenAction


                    
                    
                    ScreenRefreshAction

Undocumented

Declaration

Swift

public struct ScreenRefreshAction<Container> : ScreenAction where Container : ScreenContainer


                    
                    
                    ScreenRefreshableContainer

Undocumented

Declaration

Swift

public protocol ScreenRefreshableContainer : ScreenContainer


                    
                    
                    ScreenTryAction

Undocumented

Declaration

Swift

public struct ScreenTryAction<Action> : ScreenAction where Action : ScreenAction


                    
                    
                    ScreenTryResolution

Undocumented

Declaration

Swift

public struct ScreenTryResolution<Container, Output> where Container : ScreenContainer


                    
                    
                    ScreenDismissAction

Dismisses the screen container that was presented modally by the container in which the action is performed.

Note

Unlike the dismiss(animated:completion:) method of UIViewController, this action dismisses only the presented container.

Declaration

Swift

public struct ScreenDismissAction<Container> : ScreenAction where Container : UIViewController


                    
                    
                    ScreenPresentAction

Presents a screen modally.

Declaration

Swift

public struct ScreenPresentAction<
    New: Screen,
    Container: UIViewController
>: ScreenAction where New.Container: UIViewController


                    
                    
                    ScreenPresentedAction

Retrieves the screen container that is presented by the current container, or one of its ancestors in the container hierarchy.

Declaration

Swift

public struct ScreenPresentedAction<
    Container: UIViewController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenPresentingAction

Retrieves the screen container that presented the current container.

Declaration

Swift

public struct ScreenPresentingAction<
    Container: UIViewController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenStackAction

Retrieves the nearest ancestor in the container hierarchy that is a stack container.

Declaration

Swift

public struct ScreenStackAction<
    Container: UIViewController,
    Output: UINavigationController
>: ScreenAction


                    
                    
                    ScreenTabsAction

Retrieves the nearest ancestor in the container hierarchy that is a tabs container.

Declaration

Swift

public struct ScreenTabsAction<
    Container: UIViewController,
    Output: UITabBarController
>: ScreenAction


                    
                    
                    ScreenWindowAction

Retrieves the window container of the current container.

Declaration

Swift

public struct ScreenWindowAction<
    Container: UIViewController,
    Output: UIWindow
>: ScreenAction


                    
                    
                    ScreenSetStackAction

Undocumented

Declaration

Swift

public struct ScreenSetStackAction<Container> : ScreenAction where Container : UINavigationController


                    
                    
                    ScreenStackModifier

Undocumented

Declaration

Swift

public protocol ScreenStackModifier : CustomStringConvertible


                    
                    
                    ScreenStackClearModifier

Undocumented

Declaration

Swift

public struct ScreenStackClearModifier : ScreenStackModifier


                    
                    
                    ScreenStackPushModifier

Undocumented

Declaration

Swift

public struct ScreenStackPushModifier<
    New: Screen
>: ScreenStackModifier where New.Container: UIViewController


                    
                    
                    ScreenStackReplaceModifier

Undocumented

Declaration

Swift

public struct ScreenStackReplaceModifier<
    New: Screen
>: ScreenStackModifier where New.Container: UIViewController


                    
                    
                    ScreenStackPopModifier

Undocumented

Declaration

Swift

public struct ScreenStackPopModifier : ScreenStackModifier


                    
                    
                    ScreenStackPopPredicate

Undocumented

Declaration

Swift

public struct ScreenStackPopPredicate : CustomStringConvertible


                    
                    
                    ScreenStackAnimation

Undocumented

Declaration

Swift

public enum ScreenStackAnimation

extension ScreenStackAnimation: Equatable


                    
                    
                    ScreenStackCustomAnimation

Undocumented

Declaration

Swift

public protocol ScreenStackCustomAnimation


                    
                    
                    ScreenStackTransitionAnimation

Undocumented

Declaration

Swift

public struct ScreenStackTransitionAnimation : ScreenStackCustomAnimation, Equatable


                    
                    
                    ScreenStackRootAction

Undocumented

Declaration

Swift

public struct ScreenStackRootAction<
    Container: UINavigationController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenStackTopAction

Undocumented

Declaration

Swift

public struct ScreenStackTopAction<
    Container: UINavigationController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenStackVisibleAction

Undocumented

Declaration

Swift

public struct ScreenStackVisibleAction<
    Container: UINavigationController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenSelectTabAction

Undocumented

Declaration

Swift

public struct ScreenSelectTabAction<
    Container: UITabBarController,
    Output: ScreenContainer
>: ScreenAction


                    
                    
                    ScreenTabAnimation

Undocumented

Declaration

Swift

public enum ScreenTabAnimation


                    
                    
                    ScreenTabCustomAnimation

Undocumented

Declaration

Swift

public protocol ScreenTabCustomAnimation


                    
                    
                    ScreenTabTransitionAnimation

Undocumented

Declaration

Swift

public struct ScreenTabTransitionAnimation : ScreenTabCustomAnimation


                    
                    
                    ScreenTabPredicate

Undocumented

Declaration

Swift

public struct ScreenTabPredicate : CustomStringConvertible


                    
                    
                    ScreenSelectedTabAction

Undocumented

Declaration

Swift

public struct ScreenSelectedTabAction<
    Container: UITabBarController,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenSetupTabAction

Undocumented

Declaration

Swift

public struct ScreenSetupTabAction<
    New: Screen,
    Container: UITabBarController
>: ScreenAction where New.Container: UIViewController


                    
                    
                    ScreenMakeKeyAction

Makes the receiver the key window.

Declaration

Swift

public struct ScreenMakeKeyAction<Container> : ScreenAction where Container : UIWindow


                    
                    
                    ScreenMakeKeyAndVisibleAction

Shows the window container and makes it the key window.

Declaration

Swift

public struct ScreenMakeKeyAndVisibleAction<Container> : ScreenAction where Container : UIWindow


                    
                    
                    ScreenRootAction

Undocumented

Declaration

Swift

public struct ScreenRootAction<
    Container: UIWindow,
    Output: UIViewController
>: ScreenAction


                    
                    
                    ScreenSetRootAction

Undocumented

Declaration

Swift

public struct ScreenSetRootAction<
    New: Screen,
    Container: UIWindow
>: ScreenAction where New.Container: UIViewController


                    
                    
                    ScreenRootAnimation

Undocumented

Declaration

Swift

public enum ScreenRootAnimation


                    
                    
                    ScreenRootCustomAnimation

Undocumented

Declaration

Swift

public protocol ScreenRootCustomAnimation


                    
                    
                    ScreenRootTransitionAnimation

Undocumented

Declaration

Swift

public struct ScreenRootTransitionAnimation : ScreenRootCustomAnimation