igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface SearchInputActions

    The actions of SearchInputScreen: the methods you call on its handle while the screen is open.

    interface SearchInputActions {
        change: <Self extends ScreenHandle>(
            this: Self,
            ...args: [query: string],
        ) => Effect<
            Self,
            ScreenDataActionFailure<
                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | SchemaError
                | GraphqlRootFieldMissingError,
            >,
            never,
        >;
        search: (
            ...args: readonly [string],
        ) => Effect<
            AssembledHandle<
                "SearchResultsTopTab",
                "screen",
                {
                    query: string;
                    session: {
                        clientUuidRankToken?: string;
                        searchSessionId: string;
                        serpSessionId: string;
                        typeaheadSessionId?: string;
                    };
                },
                SearchResultsTopTabActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
    }
    Index

    Properties

    change search

    Properties

    change: <Self extends ScreenHandle>(
        this: Self,
        ...args: [query: string],
    ) => Effect<
        Self,
        ScreenDataActionFailure<
            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | SchemaError
            | GraphqlRootFieldMissingError,
        >,
        never,
    >

    Types in the search field (query): looks the text up. Answers the field shown again over the fresh data (the query, its results and the rank token); continue from it for the next keystroke, which carries on the same typing session. A text this typing session already answered shows that answer and sends nothing.

    search: (
        ...args: readonly [string],
    ) => Effect<
        AssembledHandle<
            "SearchResultsTopTab",
            "screen",
            {
                query: string;
                session: {
                    clientUuidRankToken?: string;
                    searchSessionId: string;
                    serpSessionId: string;
                    typeaheadSessionId?: string;
                };
            },
            SearchResultsTopTabActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps the keyboard's search key with query: opens the Top results of the search. Answers its handle.

    Settings

    Member Visibility

    On This Page

    Properties