jellyfin-api/org.jellyfin.sdk.api.operations/SearchApi/getSearchHints

getSearchHints

suspend fun getSearchHints(startIndex: Int? = null, limit: Int? = null, userId: <Error class: unknown class>? = null, searchTerm: String, includeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), excludeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), mediaTypes: Collection<<Error class: unknown class>>? = emptyList(), parentId: <Error class: unknown class>? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, includePeople: Boolean? = true, includeMedia: Boolean? = true, includeGenres: Boolean? = true, includeStudios: Boolean? = true, includeArtists: Boolean? = true): Response<<Error class: unknown class>>

Gets the search hint result.

Parameters

startIndex

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

limit

Optional. The maximum number of records to return.

userId

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

searchTerm

The search term to filter on.

includeItemTypes

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

excludeItemTypes

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

mediaTypes

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

parentId

If specified, only children of the parent are returned.

isMovie

Optional filter for movies.

isSeries

Optional filter for series.

isNews

Optional filter for news.

isKids

Optional filter for kids.

isSports

Optional filter for sports.

includePeople

Optional filter whether to include people.

includeMedia

Optional filter whether to include media.

includeGenres

Optional filter whether to include genres.

includeStudios

Optional filter whether to include studios.

includeArtists

Optional filter whether to include artists.

suspend fun getSearchHints(request: <Error class: unknown class>): Response<<Error class: unknown class>>

Gets the search hint result.

Parameters

request

The request parameters