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

GetItemsRequest

data class GetItemsRequest(val userId: UUID? = null, val maxOfficialRating: String? = null, val hasThemeSong: Boolean? = null, val hasThemeVideo: Boolean? = null, val hasSubtitles: Boolean? = null, val hasSpecialFeature: Boolean? = null, val hasTrailer: Boolean? = null, val adjacentTo: UUID? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val hasParentalRating: Boolean? = null, val isHd: Boolean? = null, val is4k: Boolean? = null, val locationTypes: Collection<LocationType>? = null, val excludeLocationTypes: Collection<LocationType>? = null, val isMissing: Boolean? = null, val isUnaired: Boolean? = null, val minCommunityRating: Double? = null, val minCriticRating: Double? = null, val minPremiereDate: DateTime? = null, val minDateLastSaved: DateTime? = null, val minDateLastSavedForUser: DateTime? = null, val maxPremiereDate: DateTime? = null, val hasOverview: Boolean? = null, val hasImdbId: Boolean? = null, val hasTmdbId: Boolean? = null, val hasTvdbId: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val excludeItemIds: Collection<UUID>? = null, val startIndex: Int? = null, val limit: Int? = null, val recursive: Boolean? = null, val searchTerm: String? = null, val sortOrder: Collection<SortOrder>? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val imageTypes: Collection<ImageType>? = null, val sortBy: Collection<ItemSortBy>? = null, val isPlayed: Boolean? = null, val genres: Collection<String>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val artists: Collection<String>? = null, val excludeArtistIds: Collection<UUID>? = null, val artistIds: Collection<UUID>? = null, val albumArtistIds: Collection<UUID>? = null, val contributingArtistIds: Collection<UUID>? = null, val albums: Collection<String>? = null, val albumIds: Collection<UUID>? = null, val ids: Collection<UUID>? = null, val videoTypes: Collection<VideoType>? = null, val minOfficialRating: String? = null, val isLocked: Boolean? = null, val isPlaceHolder: Boolean? = null, val hasOfficialRating: Boolean? = null, val collapseBoxSetItems: Boolean? = null, val minWidth: Int? = null, val minHeight: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val is3d: Boolean? = null, val seriesStatus: Collection<SeriesStatus>? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val studioIds: Collection<UUID>? = null, val genreIds: Collection<UUID>? = null, val enableTotalRecordCount: Boolean? = true, val enableImages: Boolean? = true)

Items based on a query.

Constructors

GetItemsRequest

constructor(userId: UUID? = null, maxOfficialRating: String? = null, hasThemeSong: Boolean? = null, hasThemeVideo: Boolean? = null, hasSubtitles: Boolean? = null, hasSpecialFeature: Boolean? = null, hasTrailer: Boolean? = null, adjacentTo: UUID? = null, indexNumber: Int? = null, parentIndexNumber: Int? = null, hasParentalRating: Boolean? = null, isHd: Boolean? = null, is4k: Boolean? = null, locationTypes: Collection<LocationType>? = null, excludeLocationTypes: Collection<LocationType>? = null, isMissing: Boolean? = null, isUnaired: Boolean? = null, minCommunityRating: Double? = null, minCriticRating: Double? = null, minPremiereDate: DateTime? = null, minDateLastSaved: DateTime? = null, minDateLastSavedForUser: DateTime? = null, maxPremiereDate: DateTime? = null, hasOverview: Boolean? = null, hasImdbId: Boolean? = null, hasTmdbId: Boolean? = null, hasTvdbId: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, excludeItemIds: Collection<UUID>? = null, startIndex: Int? = null, limit: Int? = null, recursive: Boolean? = null, searchTerm: String? = null, sortOrder: Collection<SortOrder>? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, filters: Collection<ItemFilter>? = null, isFavorite: Boolean? = null, mediaTypes: Collection<MediaType>? = null, imageTypes: Collection<ImageType>? = null, sortBy: Collection<ItemSortBy>? = null, isPlayed: Boolean? = null, genres: Collection<String>? = null, officialRatings: Collection<String>? = null, tags: Collection<String>? = null, years: Collection<Int>? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, person: String? = null, personIds: Collection<UUID>? = null, personTypes: Collection<String>? = null, studios: Collection<String>? = null, artists: Collection<String>? = null, excludeArtistIds: Collection<UUID>? = null, artistIds: Collection<UUID>? = null, albumArtistIds: Collection<UUID>? = null, contributingArtistIds: Collection<UUID>? = null, albums: Collection<String>? = null, albumIds: Collection<UUID>? = null, ids: Collection<UUID>? = null, videoTypes: Collection<VideoType>? = null, minOfficialRating: String? = null, isLocked: Boolean? = null, isPlaceHolder: Boolean? = null, hasOfficialRating: Boolean? = null, collapseBoxSetItems: Boolean? = null, minWidth: Int? = null, minHeight: Int? = null, maxWidth: Int? = null, maxHeight: Int? = null, is3d: Boolean? = null, seriesStatus: Collection<SeriesStatus>? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, studioIds: Collection<UUID>? = null, genreIds: Collection<UUID>? = null, enableTotalRecordCount: Boolean? = true, enableImages: Boolean? = true)

Properties

adjacentTo

val adjacentTo: UUID? = null

Optional. Return items that are siblings of a supplied item.

albumArtistIds

val albumArtistIds: Collection<UUID>? = null

Optional. If specified, results will be filtered to include only those containing the specified album artist id.

albumIds

val albumIds: Collection<UUID>? = null

Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.

albums

val albums: Collection<String>? = null

Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.

artistIds

val artistIds: Collection<UUID>? = null

Optional. If specified, results will be filtered to include only those containing the specified artist id.

artists

val artists: Collection<String>? = null

Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.

collapseBoxSetItems

val collapseBoxSetItems: Boolean? = null

Whether or not to hide items behind their boxsets.

contributingArtistIds

val contributingArtistIds: Collection<UUID>? = null

Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.

enableImages

val enableImages: Boolean? = true

Optional, include image information in output.

enableImageTypes

val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

enableTotalRecordCount

val enableTotalRecordCount: Boolean? = true

Optional. Enable the total record count.

enableUserData

val enableUserData: Boolean? = null

Optional, include user data.

excludeArtistIds

val excludeArtistIds: Collection<UUID>? = null

Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.

excludeItemIds

val excludeItemIds: Collection<UUID>? = null

Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.

excludeItemTypes

val excludeItemTypes: Collection<BaseItemKind>? = null

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

excludeLocationTypes

val excludeLocationTypes: Collection<LocationType>? = null

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

fields

val fields: Collection<ItemFields>? = null

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

filters

val filters: Collection<ItemFilter>? = null

Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.

genreIds

val genreIds: Collection<UUID>? = null

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

genres

val genres: Collection<String>? = null

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

hasImdbId

val hasImdbId: Boolean? = null

Optional filter by items that have an IMDb id or not.

hasOfficialRating

val hasOfficialRating: Boolean? = null

Optional filter by items that have official ratings.

hasOverview

val hasOverview: Boolean? = null

Optional filter by items that have an overview or not.

hasParentalRating

val hasParentalRating: Boolean? = null

Optional filter by items that have or do not have a parental rating.

hasSpecialFeature

val hasSpecialFeature: Boolean? = null

Optional filter by items with special features.

hasSubtitles

val hasSubtitles: Boolean? = null

Optional filter by items with subtitles.

hasThemeSong

val hasThemeSong: Boolean? = null

Optional filter by items with theme songs.

hasThemeVideo

val hasThemeVideo: Boolean? = null

Optional filter by items with theme videos.

hasTmdbId

val hasTmdbId: Boolean? = null

Optional filter by items that have a TMDb id or not.

hasTrailer

val hasTrailer: Boolean? = null

Optional filter by items with trailers.

hasTvdbId

val hasTvdbId: Boolean? = null

Optional filter by items that have a TVDb id or not.

ids

val ids: Collection<UUID>? = null

Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.

imageTypeLimit

val imageTypeLimit: Int? = null

Optional, the max number of images to return, per image type.

imageTypes

val imageTypes: Collection<ImageType>? = null

Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.

includeItemTypes

val includeItemTypes: Collection<BaseItemKind>? = null

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

indexNumber

val indexNumber: Int? = null

Optional filter by index number.

is3d

val is3d: Boolean? = null

Optional filter by items that are 3D, or not.

is4k

val is4k: Boolean? = null

Optional filter by items that are 4K or not.

isFavorite

val isFavorite: Boolean? = null

Optional filter by items that are marked as favorite, or not.

isHd

val isHd: Boolean? = null

Optional filter by items that are HD or not.

isKids

val isKids: Boolean? = null

Optional filter for live tv kids.

isLocked

val isLocked: Boolean? = null

Optional filter by items that are locked.

isMissing

val isMissing: Boolean? = null

Optional filter by items that are missing episodes or not.

isMovie

val isMovie: Boolean? = null

Optional filter for live tv movies.

isNews

val isNews: Boolean? = null

Optional filter for live tv news.

isPlaceHolder

val isPlaceHolder: Boolean? = null

Optional filter by items that are placeholders.

isPlayed

val isPlayed: Boolean? = null

Optional filter by items that are played, or not.

isSeries

val isSeries: Boolean? = null

Optional filter for live tv series.

isSports

val isSports: Boolean? = null

Optional filter for live tv sports.

isUnaired

val isUnaired: Boolean? = null

Optional filter by items that are unaired episodes or not.

limit

val limit: Int? = null

Optional. The maximum number of records to return.

locationTypes

val locationTypes: Collection<LocationType>? = null

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

maxHeight

val maxHeight: Int? = null

Optional. Filter by the maximum height of the item.

maxOfficialRating

val maxOfficialRating: String? = null

Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).

maxPremiereDate

val maxPremiereDate: DateTime? = null

Optional. The maximum premiere date. Format = ISO.

maxWidth

val maxWidth: Int? = null

Optional. Filter by the maximum width of the item.

mediaTypes

val mediaTypes: Collection<MediaType>? = null

Optional filter by MediaType. Allows multiple, comma delimited.

minCommunityRating

val minCommunityRating: Double? = null

Optional filter by minimum community rating.

minCriticRating

val minCriticRating: Double? = null

Optional filter by minimum critic rating.

minDateLastSaved

val minDateLastSaved: DateTime? = null

Optional. The minimum last saved date. Format = ISO.

minDateLastSavedForUser

val minDateLastSavedForUser: DateTime? = null

Optional. The minimum last saved date for the current user. Format = ISO.

minHeight

val minHeight: Int? = null

Optional. Filter by the minimum height of the item.

minOfficialRating

val minOfficialRating: String? = null

Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).

minPremiereDate

val minPremiereDate: DateTime? = null

Optional. The minimum premiere date. Format = ISO.

minWidth

val minWidth: Int? = null

Optional. Filter by the minimum width of the item.

nameLessThan

val nameLessThan: String? = null

Optional filter by items whose name is equally or lesser than a given input string.

nameStartsWith

val nameStartsWith: String? = null

Optional filter by items whose name is sorted equally than a given input string.

nameStartsWithOrGreater

val nameStartsWithOrGreater: String? = null

Optional filter by items whose name is sorted equally or greater than a given input string.

officialRatings

val officialRatings: Collection<String>? = null

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

parentId

val parentId: UUID? = null

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

parentIndexNumber

val parentIndexNumber: Int? = null

Optional filter by parent index number.

person

val person: String? = null

Optional. If specified, results will be filtered to include only those containing the specified person.

personIds

val personIds: Collection<UUID>? = null

Optional. If specified, results will be filtered to include only those containing the specified person id.

personTypes

val personTypes: Collection<String>? = null

Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

recursive

val recursive: Boolean? = null

When searching within folders, this determines whether or not the search will be recursive. true/false.

searchTerm

val searchTerm: String? = null

Optional. Filter based on a search term.

seriesStatus

val seriesStatus: Collection<SeriesStatus>? = null

Optional filter by Series Status. Allows multiple, comma delimited.

sortBy

val sortBy: Collection<ItemSortBy>? = null

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

sortOrder

val sortOrder: Collection<SortOrder>? = null

Sort Order - Ascending, Descending.

startIndex

val startIndex: Int? = null

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

studioIds

val studioIds: Collection<UUID>? = null

Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

studios

val studios: Collection<String>? = null

Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.