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

GetChannelsRequest

@Serializable

data class GetChannelsRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val supportsLatestItems: Boolean? = null, val supportsMediaDeletion: Boolean? = null, val isFavorite: Boolean? = null)

Available channels.

Constructors

GetChannelsRequest

constructor(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, supportsLatestItems: Boolean? = null, supportsMediaDeletion: Boolean? = null, isFavorite: Boolean? = null)

Properties

@SerialName(value = "isFavorite")

val isFavorite: Boolean?

Optional. Filter by channels that are favorite.

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

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

supportsLatestItems

@SerialName(value = "supportsLatestItems")

val supportsLatestItems: Boolean?

Optional. Filter by channels that support getting latest items.

supportsMediaDeletion

@SerialName(value = "supportsMediaDeletion")

val supportsMediaDeletion: Boolean?

Optional. Filter by channels that support media deletion.

@SerialName(value = "userId")

val userId: UUID?

User Id to filter by. Use System.Guid.Empty to not filter by user.