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

GetYearsRequest

data class GetYearsRequest(val startIndex: Int? = null, val limit: Int? = 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 mediaTypes: Collection<MediaType>? = null, val sortBy: Collection<ItemSortBy>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val recursive: Boolean? = true, val enableImages: Boolean? = true)

Get years.

Constructors

Link copied to clipboard
constructor(startIndex: Int? = null, limit: Int? = null, sortOrder: Collection<SortOrder>? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, mediaTypes: Collection<MediaType>? = null, sortBy: Collection<ItemSortBy>? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, userId: UUID? = null, recursive: Boolean? = true, enableImages: Boolean? = true)

Properties

Link copied to clipboard
val enableImages: Boolean? = true

Optional. Include image information in output.

Link copied to clipboard
val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

Link copied to clipboard
val enableUserData: Boolean? = null

Optional. Include user data.

Link copied to clipboard
val excludeItemTypes: Collection<BaseItemKind>? = null

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

Link copied to clipboard
val fields: Collection<ItemFields>? = null

Optional. Specify additional fields of information to return in the output.

Link copied to clipboard
val imageTypeLimit: Int? = null

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

Link copied to clipboard
val includeItemTypes: Collection<BaseItemKind>? = null

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

Link copied to clipboard
val limit: Int? = null

Optional. The maximum number of records to return.

Link copied to clipboard
val mediaTypes: Collection<MediaType>? = null

Optional. Filter by MediaType. Allows multiple, comma delimited.

Link copied to clipboard
val parentId: UUID? = null

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

Link copied to clipboard
val recursive: Boolean? = true

Search recursively.

Link copied to clipboard
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.

Link copied to clipboard
val sortOrder: Collection<SortOrder>? = null

Sort Order - Ascending,Descending.

Link copied to clipboard
val startIndex: Int? = null

Skips over a given number of items within the results. Use for paging.

Link copied to clipboard
val userId: UUID? = null

User Id.