Function SearchApiFp

Returns {
    getSearchHints(
        searchTerm: string,
        startIndex?: number,
        limit?: number,
        userId?: string,
        includeItemTypes?: BaseItemKind[],
        excludeItemTypes?: BaseItemKind[],
        mediaTypes?: MediaType[],
        parentId?: string,
        isMovie?: boolean,
        isSeries?: boolean,
        isNews?: boolean,
        isKids?: boolean,
        isSports?: boolean,
        includePeople?: boolean,
        includeMedia?: boolean,
        includeGenres?: boolean,
        includeStudios?: boolean,
        includeArtists?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchHintResult>,
    >;
}

• getSearchHints:function

  • getSearchHints(
        searchTerm: string,
        startIndex?: number,
        limit?: number,
        userId?: string,
        includeItemTypes?: BaseItemKind[],
        excludeItemTypes?: BaseItemKind[],
        mediaTypes?: MediaType[],
        parentId?: string,
        isMovie?: boolean,
        isSeries?: boolean,
        isNews?: boolean,
        isKids?: boolean,
        isSports?: boolean,
        includePeople?: boolean,
        includeMedia?: boolean,
        includeGenres?: boolean,
        includeStudios?: boolean,
        includeArtists?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchHintResult>,
    >

  • Parameters

    • searchTerm: string

      The search term to filter on.
    • OptionalstartIndex: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • OptionaluserId: string

      Optional. Supply a user id to search within a user&#39;s library or omit to search all.
    • OptionalincludeItemTypes: BaseItemKind[]

      If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
    • OptionalexcludeItemTypes: BaseItemKind[]

      If specified, results with these item types are filtered out. This allows multiple, comma delimited.
    • OptionalmediaTypes: MediaType[]

      If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
    • OptionalparentId: string

      If specified, only children of the parent are returned.
    • OptionalisMovie: boolean

      Optional filter for movies.
    • OptionalisSeries: boolean

      Optional filter for series.
    • OptionalisNews: boolean

      Optional filter for news.
    • OptionalisKids: boolean

      Optional filter for kids.
    • OptionalisSports: boolean

      Optional filter for sports.
    • OptionalincludePeople: boolean

      Optional filter whether to include people.
    • OptionalincludeMedia: boolean

      Optional filter whether to include media.
    • OptionalincludeGenres: boolean

      Optional filter whether to include genres.
    • OptionalincludeStudios: boolean

      Optional filter whether to include studios.
    • OptionalincludeArtists: boolean

      Optional filter whether to include artists.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchHintResult>,
    >

    Throws