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

GetYearsRequest

@Serializable

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

GetYearsRequest

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

enableImages

@SerialName(value = "enableImages")

val enableImages: Boolean?

Optional. Include image information in output.

enableImageTypes

@SerialName(value = "enableImageTypes")

val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

enableUserData

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional. Include user data.

excludeItemTypes

@SerialName(value = "excludeItemTypes")

val excludeItemTypes: Collection<BaseItemKind>?

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

fields

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

imageTypeLimit

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

includeItemTypes

@SerialName(value = "includeItemTypes")

val includeItemTypes: Collection<BaseItemKind>?

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

limit

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

mediaTypes

@SerialName(value = "mediaTypes")

val mediaTypes: Collection<MediaType>?

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

parentId

@SerialName(value = "parentId")

val parentId: UUID?

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

recursive

@SerialName(value = "recursive")

val recursive: Boolean?

Search recursively.

sortBy

@SerialName(value = "sortBy")

val sortBy: Collection<ItemSortBy>?

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

@SerialName(value = "sortOrder")

val sortOrder: Collection<SortOrder>?

Sort Order - Ascending,Descending.

startIndex

@SerialName(value = "startIndex")

val startIndex: Int?

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

userId

@SerialName(value = "userId")

val userId: UUID?

User Id.