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

GetQueryFiltersRequest

@Serializable

data class GetQueryFiltersRequest(val userId: UUID? = null, val parentId: UUID? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isAiring: Boolean? = null, val isMovie: Boolean? = null, val isSports: Boolean? = null, val isKids: Boolean? = null, val isNews: Boolean? = null, val isSeries: Boolean? = null, val recursive: Boolean? = null)

Query filters.

Constructors

GetQueryFiltersRequest

constructor(userId: UUID? = null, parentId: UUID? = null, includeItemTypes: Collection<BaseItemKind>? = null, isAiring: Boolean? = null, isMovie: Boolean? = null, isSports: Boolean? = null, isKids: Boolean? = null, isNews: Boolean? = null, isSeries: Boolean? = null, recursive: Boolean? = null)

Properties

includeItemTypes

@SerialName(value = "includeItemTypes")

val includeItemTypes: Collection<BaseItemKind>?

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

@SerialName(value = "isAiring")

val isAiring: Boolean?

Optional. Is item airing.

@SerialName(value = "isKids")

val isKids: Boolean?

Optional. Is item kids.

@SerialName(value = "isMovie")

val isMovie: Boolean?

Optional. Is item movie.

@SerialName(value = "isNews")

val isNews: Boolean?

Optional. Is item news.

@SerialName(value = "isSeries")

val isSeries: Boolean?

Optional. Is item series.

@SerialName(value = "isSports")

val isSports: Boolean?

Optional. Is item sports.

@SerialName(value = "parentId")

val parentId: UUID?

Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

@SerialName(value = "recursive")

val recursive: Boolean?

Optional. Search recursive.

@SerialName(value = "userId")

val userId: UUID?

Optional. User id.