Interface SearchApiGetSearchHintsRequest

Request parameters for getSearchHints operation in SearchApi.

Export

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;
}

Properties

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

Properties

Optional ReadonlyexcludeItemTypes

excludeItemTypes?: BaseItemKind[]

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

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludeArtists

includeArtists?: boolean

Optional filter whether to include artists.

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludeGenres

includeGenres?: boolean

Optional filter whether to include genres.

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

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

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludeMedia

includeMedia?: boolean

Optional filter whether to include media.

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludePeople

includePeople?: boolean

Optional filter whether to include people.

Memberof

SearchApiGetSearchHints

Optional ReadonlyincludeStudios

includeStudios?: boolean

Optional filter whether to include studios.

Memberof

SearchApiGetSearchHints

Optional ReadonlyisKids

isKids?: boolean

Optional filter for kids.

Memberof

SearchApiGetSearchHints

Optional ReadonlyisMovie

isMovie?: boolean

Optional filter for movies.

Memberof

SearchApiGetSearchHints

Optional ReadonlyisNews

isNews?: boolean

Optional filter for news.

Memberof

SearchApiGetSearchHints

Optional ReadonlyisSeries

isSeries?: boolean

Optional filter for series.

Memberof

SearchApiGetSearchHints

Optional ReadonlyisSports

isSports?: boolean

Optional filter for sports.

Memberof

SearchApiGetSearchHints

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

SearchApiGetSearchHints

Optional ReadonlymediaTypes

mediaTypes?: MediaType[]

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

Memberof

SearchApiGetSearchHints

Optional ReadonlyparentId

parentId?: string

If specified, only children of the parent are returned.

Memberof

SearchApiGetSearchHints

ReadonlysearchTerm

searchTerm: string

The search term to filter on.

Memberof

SearchApiGetSearchHints

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

SearchApiGetSearchHints

Optional ReadonlyuserId

userId?: string

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

Memberof

SearchApiGetSearchHints

Settings

Member Visibility

On This Page

Properties