foo-webview-sdk
    Preparing search index...

    Interface DiscoverySearchCommandsSuccess

    Successful response from discovery.searchCommands.

    interface DiscoverySearchCommandsSuccess {
        contextMenuHits: number;
        count: number;
        expandDynamic: boolean;
        includeHidden: boolean;
        mainMenuHits: number;
        query: string;
        results: DiscoverySearchResult[];
        scope: "all" | "contextmenu" | "mainmenu";
        stateKnown: boolean;
        success: true;
    }
    Index
    contextMenuHits count expandDynamic includeHidden mainMenuHits query results scope stateKnown success
    contextMenuHits: number

    Hits from the context menu.

    count: number

    Number of entries in results.

    expandDynamic: boolean

    The expandDynamic that applied.

    includeHidden: boolean

    The includeHidden that applied.

    mainMenuHits: number

    Hits from the main menu.

    query: string

    The query as given.

    results: DiscoverySearchResult[]

    The hits, main menu first.

    scope: "all" | "contextmenu" | "mainmenu"

    The scope that applied.

    stateKnown: boolean

    Whether context-menu state was observed. False when the context family was searched with nothing selected or playing; the hits' enabled and checked must not be filtered on then.

    success: true

    Always true here; a failed call resolves with ApiFailure instead.

    Settings
    Member Visibility

    On This Page
    Properties