Function SuggestionsApiFp

Returns {
    getSuggestions(
        userId?: string,
        mediaType?: MediaType[],
        type?: BaseItemKind[],
        startIndex?: number,
        limit?: number,
        enableTotalRecordCount?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
}

• getSuggestions: function

  • getSuggestions(
        userId?: string,
        mediaType?: MediaType[],
        type?: BaseItemKind[],
        startIndex?: number,
        limit?: number,
        enableTotalRecordCount?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

    • OptionaluserId: string

      The user id.
    • OptionalmediaType: MediaType[]

      The media types.
    • Optionaltype: BaseItemKind[]

      The type.
    • OptionalstartIndex: number

      Optional. The start index.
    • Optionallimit: number

      Optional. The limit.
    • OptionalenableTotalRecordCount: boolean

      Whether to enable the total record count.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws