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

GetSearchHintsRequest

@Serializable

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

@SerialName(value = "excludeItemTypes")

val excludeItemTypes: Collection<BaseItemKind>?

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

@SerialName(value = "includeArtists")

val includeArtists: Boolean?

Optional filter whether to include artists.

@SerialName(value = "includeGenres")

val includeGenres: Boolean?

Optional filter whether to include genres.

includeItemTypes

@SerialName(value = "includeItemTypes")

val includeItemTypes: Collection<BaseItemKind>?

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

@SerialName(value = "includeMedia")

val includeMedia: Boolean?

Optional filter whether to include media.

@SerialName(value = "includePeople")

val includePeople: Boolean?

Optional filter whether to include people.

@SerialName(value = "includeStudios")

val includeStudios: Boolean?

Optional filter whether to include studios.

@SerialName(value = "isKids")

val isKids: Boolean?

Optional filter for kids.

@SerialName(value = "isMovie")

val isMovie: Boolean?

Optional filter for movies.

@SerialName(value = "isNews")

val isNews: Boolean?

Optional filter for news.

@SerialName(value = "isSeries")

val isSeries: Boolean?

Optional filter for series.

@SerialName(value = "isSports")

val isSports: Boolean?

Optional filter for sports.

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "mediaTypes")

val mediaTypes: Collection<MediaType>?

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

@SerialName(value = "parentId")

val parentId: UUID?

If specified, only children of the parent are returned.

@SerialName(value = "searchTerm")

val searchTerm: String

The search term to filter on.

@SerialName(value = "startIndex")

val startIndex: Int?

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

@SerialName(value = "userId")

val userId: UUID?

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