Function enterRoot

enterRoot<
    Id extends
        | "FeedTimeline"
        | "ShortUrlFeed"
        | "ClipsViewer"
        | "CommentsV2"
        | "Explore"
        | "SearchTypeahead"
        | "SerpTop"
        | "SerpUsers"
        | "UserDetail"
        | "ProfileMediaTab"
        | "ContextualFeed"
        | "DirectInbox"
        | "DirectThread"
        | "CustomizeChat"
        | "DirectThreadThemePicker"
        | "DirectThreadDetails"
        | "DirectThreadSharedMedia"
        | "DirectThreadNicknames"
        | "DirectThreadNicknameChange",
    Kind extends EnterableScreenKind,
    Input,
    Data extends object,
    State,
    E,
    R,
    Actions extends object,
    Items extends object,
>(
    definition: ScreenDefinition<
        Id,
        Kind,
        Input,
        Data,
        State,
        E,
        R,
        Actions,
        Items,
    >,
    via: ScreenVia,
    input: Input,
): Effect<
    AssembledHandle<Id, Kind, Data, Actions, Items, undefined>,

        | InvalidSkipOrdinalsError
        | ScreenEnterConcurrentError
        | ScreenEnterNavigationError
        | ScreenDataError
        | E
        | ScreenItemListFailure<Items>,
    MobileNavigation | ScreenStack | R | ScreenItemListServices<Items>,
>
Opens the first screen of a path through the launch edge: what a platform's OpenApp (and a bottom-bar tab switch) calls with the launch's source and ordinal skip — facts of the launch, never a userland argument.
Type Parameters
- Id extends
      | "FeedTimeline"
      | "ShortUrlFeed"
      | "ClipsViewer"
      | "CommentsV2"
      | "Explore"
      | "SearchTypeahead"
      | "SerpTop"
      | "SerpUsers"
      | "UserDetail"
      | "ProfileMediaTab"
      | "ContextualFeed"
      | "DirectInbox"
      | "DirectThread"
      | "CustomizeChat"
      | "DirectThreadThemePicker"
      | "DirectThreadDetails"
      | "DirectThreadSharedMedia"
      | "DirectThreadNicknames"
      | "DirectThreadNicknameChange"
- Kind extends EnterableScreenKind
- Input
- Data extends object
- State
- E
- R
- Actions extends object
- Items extends object
Parameters
- definition: ScreenDefinition<Id, Kind, Input, Data, State, E, R, Actions, Items>
- via: ScreenVia
- input: Input
Returns Effect<
    AssembledHandle<Id, Kind, Data, Actions, Items, undefined>,

        | InvalidSkipOrdinalsError
        | ScreenEnterConcurrentError
        | ScreenEnterNavigationError
        | ScreenDataError
        | E
        | ScreenItemListFailure<Items>,
    MobileNavigation | ScreenStack | R | ScreenItemListServices<Items>,
>

Function enterRoot

Type Parameters

Parameters

Returns Effect< AssembledHandle<Id, Kind, Data, Actions, Items, undefined>, | InvalidSkipOrdinalsError | ScreenEnterConcurrentError | ScreenEnterNavigationError | ScreenDataError | E | ScreenItemListFailure<Items>, MobileNavigation | ScreenStack | R | ScreenItemListServices<Items>,>

Settings

Returns Effect<
AssembledHandle<Id, Kind, Data, Actions, Items, undefined>,

| InvalidSkipOrdinalsError
| ScreenEnterConcurrentError
| ScreenEnterNavigationError
| ScreenDataError
| E
| ScreenItemListFailure<Items>,
MobileNavigation | ScreenStack | R | ScreenItemListServices<Items>,
>