jellyfin-model/org.jellyfin.sdk.model.api/GetProgramsDto

GetProgramsDto

@Serializable

data class GetProgramsDto(val channelIds: List<UUID>? = null, val userId: UUID? = null, val minStartDate: DateTime? = null, val hasAired: Boolean? = null, val isAiring: Boolean? = null, val maxStartDate: DateTime? = null, val minEndDate: DateTime? = null, val maxEndDate: DateTime? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val startIndex: Int? = null, val limit: Int? = null, val sortBy: List<ItemSortBy>? = null, val sortOrder: List<SortOrder>? = null, val genres: List<String>? = null, val genreIds: List<UUID>? = null, val enableImages: Boolean? = null, val enableTotalRecordCount: Boolean = true, val imageTypeLimit: Int? = null, val enableImageTypes: List<ImageType>? = null, val enableUserData: Boolean? = null, val seriesTimerId: String? = null, val librarySeriesId: UUID? = null, val fields: List<ItemFields>? = null)

Get programs dto.

Constructors

constructor(channelIds: List<UUID>? = null, userId: UUID? = null, minStartDate: DateTime? = null, hasAired: Boolean? = null, isAiring: Boolean? = null, maxStartDate: DateTime? = null, minEndDate: DateTime? = null, maxEndDate: DateTime? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, startIndex: Int? = null, limit: Int? = null, sortBy: List<ItemSortBy>? = null, sortOrder: List<SortOrder>? = null, genres: List<String>? = null, genreIds: List<UUID>? = null, enableImages: Boolean? = null, enableTotalRecordCount: Boolean = true, imageTypeLimit: Int? = null, enableImageTypes: List<ImageType>? = null, enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: UUID? = null, fields: List<ItemFields>? = null)

Properties

@SerialName(value = "ChannelIds")

val channelIds: List<UUID>?

The channels to return guide information for.

@SerialName(value = "EnableImages")

val enableImages: Boolean?

Include image information in output.

enableImageTypes

@SerialName(value = "EnableImageTypes")

val enableImageTypes: List<ImageType>?

The image types to include in the output.

enableTotalRecordCount

@SerialName(value = "EnableTotalRecordCount")

val enableTotalRecordCount: Boolean

A value indicating whether retrieve total record count.

@SerialName(value = "EnableUserData")

val enableUserData: Boolean?

Include user data.

@SerialName(value = "Fields")

val fields: List<ItemFields>?

Specify additional fields of information to return in the output.

@SerialName(value = "GenreIds")

val genreIds: List<UUID>?

The genre ids to return guide information for.

@SerialName(value = "Genres")

val genres: List<String>?

The genres to return guide information for.

@SerialName(value = "HasAired")

val hasAired: Boolean?

Filter by programs that have completed airing, or not.

@SerialName(value = "ImageTypeLimit")

val imageTypeLimit: Int?

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

@SerialName(value = "IsAiring")

val isAiring: Boolean?

Filter by programs that are currently airing, or not.

@SerialName(value = "IsKids")

val isKids: Boolean?

Filter for kids.

@SerialName(value = "IsMovie")

val isMovie: Boolean?

Filter for movies.

@SerialName(value = "IsNews")

val isNews: Boolean?

Filter for news.

@SerialName(value = "IsSeries")

val isSeries: Boolean?

Filter for series.

@SerialName(value = "IsSports")

val isSports: Boolean?

Filter for sports.

librarySeriesId

@SerialName(value = "LibrarySeriesId")

val librarySeriesId: UUID?

Filter by library series id.

@SerialName(value = "Limit")

val limit: Int?

The maximum number of records to return.

@SerialName(value = "MaxEndDate")

val maxEndDate: DateTime?

The maximum premiere end date.

@SerialName(value = "MaxStartDate")

val maxStartDate: DateTime?

The maximum premiere start date.

@SerialName(value = "MinEndDate")

val minEndDate: DateTime?

The minimum premiere end date.

@SerialName(value = "MinStartDate")

val minStartDate: DateTime?

The minimum premiere start date.

@SerialName(value = "SeriesTimerId")

val seriesTimerId: String?

Filter by series timer id.

@SerialName(value = "SortBy")

val sortBy: List<ItemSortBy>?

Specify one or more sort orders, comma delimited. Options: Name, StartDate.

@SerialName(value = "SortOrder")

val sortOrder: List<SortOrder>?

Sort order.

@SerialName(value = "StartIndex")

val startIndex: Int?

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

@SerialName(value = "UserId")

val userId: UUID?

Optional. Filter by user id.