@jellyfin/sdk
    Preparing search index...

    Interface SearchApiGetSearchHintsRequest

    Request parameters for getSearchHints operation in SearchApi.

    SearchApiGetSearchHintsRequest

    interface SearchApiGetSearchHintsRequest {
        excludeItemTypes?: BaseItemKind[];
        includeArtists?: boolean;
        includeGenres?: boolean;
        includeItemTypes?: BaseItemKind[];
        includeMedia?: boolean;
        includePeople?: boolean;
        includeStudios?: boolean;
        isKids?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        limit?: number;
        mediaTypes?: MediaType[];
        parentId?: string;
        searchTerm: string;
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    excludeItemTypes? includeArtists? includeGenres? includeItemTypes? includeMedia? includePeople? includeStudios? isKids? isMovie? isNews? isSeries? isSports? limit? mediaTypes? parentId? searchTerm startIndex? userId?

    Properties

    excludeItemTypes?: BaseItemKind[]

    If specified, results with these item types are filtered out. This allows multiple, comma delimited.

    SearchApiGetSearchHints

    includeArtists?: boolean

    Optional filter whether to include artists.

    SearchApiGetSearchHints

    includeGenres?: boolean

    Optional filter whether to include genres.

    SearchApiGetSearchHints

    includeItemTypes?: BaseItemKind[]

    If specified, only results with the specified item types are returned. This allows multiple, comma delimited.

    SearchApiGetSearchHints

    includeMedia?: boolean

    Optional filter whether to include media.

    SearchApiGetSearchHints

    includePeople?: boolean

    Optional filter whether to include people.

    SearchApiGetSearchHints

    includeStudios?: boolean

    Optional filter whether to include studios.

    SearchApiGetSearchHints

    isKids?: boolean

    Optional filter for kids.

    SearchApiGetSearchHints

    isMovie?: boolean

    Optional filter for movies.

    SearchApiGetSearchHints

    isNews?: boolean

    Optional filter for news.

    SearchApiGetSearchHints

    isSeries?: boolean

    Optional filter for series.

    SearchApiGetSearchHints

    isSports?: boolean

    Optional filter for sports.

    SearchApiGetSearchHints

    limit?: number

    Optional. The maximum number of records to return.

    SearchApiGetSearchHints

    mediaTypes?: MediaType[]

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

    SearchApiGetSearchHints

    parentId?: string

    If specified, only children of the parent are returned.

    SearchApiGetSearchHints

    searchTerm: string

    The search term to filter on.

    SearchApiGetSearchHints

    startIndex?: number

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

    SearchApiGetSearchHints

    userId?: string

    Optional. Supply a user id to search within a user's library or omit to search all.

    SearchApiGetSearchHints

    Settings

    Member Visibility

    On This Page

    Properties