jellyfin-model/org.jellyfin.sdk.model.api.request/GetSearchHintsRequest

GetSearchHintsRequest

data class GetSearchHintsRequest(val startIndex: Int? = null, val limit: Int? = null, val userId: UUID? = null, val searchTerm: String, val includeItemTypes: Collection<BaseItemKind>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val mediaTypes: Collection<MediaType>? = null, val parentId: UUID? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val includePeople: Boolean? = true, val includeMedia: Boolean? = true, val includeGenres: Boolean? = true, val includeStudios: Boolean? = true, val includeArtists: Boolean? = true)

The search hint result.

Constructors

GetSearchHintsRequest

constructor(startIndex: Int? = null, limit: Int? = null, userId: UUID? = null, searchTerm: String, includeItemTypes: Collection<BaseItemKind>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, mediaTypes: Collection<MediaType>? = null, parentId: UUID? = 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)

Properties

excludeItemTypes

val excludeItemTypes: Collection<BaseItemKind>? = null

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

val includeArtists: Boolean? = true

Optional filter whether to include artists.

val includeGenres: Boolean? = true

Optional filter whether to include genres.

includeItemTypes

val includeItemTypes: Collection<BaseItemKind>? = null

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

val includeMedia: Boolean? = true

Optional filter whether to include media.

val includePeople: Boolean? = true

Optional filter whether to include people.

val includeStudios: Boolean? = true

Optional filter whether to include studios.

val isKids: Boolean? = null

Optional filter for kids.

val isMovie: Boolean? = null

Optional filter for movies.

val isNews: Boolean? = null

Optional filter for news.

val isSeries: Boolean? = null

Optional filter for series.

val isSports: Boolean? = null

Optional filter for sports.

val limit: Int? = null

Optional. The maximum number of records to return.

val mediaTypes: Collection<MediaType>? = null

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

val parentId: UUID? = null

If specified, only children of the parent are returned.

val searchTerm: String

The search term to filter on.

val startIndex: Int? = null

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

val userId: UUID? = null

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