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

GetChannelItemsRequest

@Serializable

data class GetChannelItemsRequest(val channelId: UUID, val folderId: UUID? = null, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val sortOrder: Collection<SortOrder>? = null, val filters: Collection<ItemFilter>? = null, val sortBy: Collection<ItemSortBy>? = null, val fields: Collection<ItemFields>? = null)

Get channel items.

Constructors

constructor(channelId: UUID, folderId: UUID? = null, userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, sortOrder: Collection<SortOrder>? = null, filters: Collection<ItemFilter>? = null, sortBy: Collection<ItemSortBy>? = null, fields: Collection<ItemFields>? = null)

Properties

channelId

@SerialName(value = "channelId")

val channelId: UUID

Channel Id.

fields

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

filters

@SerialName(value = "filters")

val filters: Collection<ItemFilter>?

Optional. Specify additional filters to apply.

folderId

@SerialName(value = "folderId")

val folderId: UUID?

Optional. Folder Id.

limit

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

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>?

Optional. Sort Order - Ascending,Descending.

startIndex

@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.

userId

@SerialName(value = "userId")

val userId: UUID?

Optional. User Id.