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

GetLiveTvProgramsRequest

data class GetLiveTvProgramsRequest(val channelIds: Collection<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: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val seriesTimerId: String? = null, val librarySeriesId: UUID? = null, val fields: Collection<ItemFields>? = null, val enableTotalRecordCount: Boolean? = true)

Available live tv epgs.

Constructors

GetLiveTvProgramsRequest

constructor(channelIds: Collection<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: Collection<ItemSortBy>? = null, sortOrder: Collection<SortOrder>? = null, genres: Collection<String>? = null, genreIds: Collection<UUID>? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: UUID? = null, fields: Collection<ItemFields>? = null, enableTotalRecordCount: Boolean? = true)

Properties

val channelIds: Collection<UUID>? = null

The channels to return guide information for.

val enableImages: Boolean? = null

Optional. Include image information in output.

enableImageTypes

val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

enableTotalRecordCount

val enableTotalRecordCount: Boolean? = true

Retrieve total record count.

val enableUserData: Boolean? = null

Optional. Include user data.

val fields: Collection<ItemFields>? = null

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

val genreIds: Collection<UUID>? = null

The genre ids to return guide information for.

val genres: Collection<String>? = null

The genres to return guide information for.

val hasAired: Boolean? = null

Optional. Filter by programs that have completed airing, or not.

val imageTypeLimit: Int? = null

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

val isAiring: Boolean? = null

Optional. Filter by programs that are currently airing, or not.

val isKids: Boolean? = null

Optional. Filter for kids.

val isMovie: Boolean? = null

Optional. Filter for movies.

val isNews: Boolean? = null

Optional. Filter for news.

val isSeries: Boolean? = null

Optional. Filter for series.

val isSports: Boolean? = null

Optional. Filter for sports.

librarySeriesId

val librarySeriesId: UUID? = null

Optional. Filter by library series id.

val limit: Int? = null

Optional. The maximum number of records to return.

val maxEndDate: DateTime? = null

Optional. The maximum premiere end date.

val maxStartDate: DateTime? = null

Optional. The maximum premiere start date.

val minEndDate: DateTime? = null

Optional. The minimum premiere end date.

val minStartDate: DateTime? = null

Optional. The minimum premiere start date.

val seriesTimerId: String? = null

Optional. Filter by series timer id.

val sortBy: Collection<ItemSortBy>? = null

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

val sortOrder: Collection<SortOrder>? = null

Sort Order - Ascending,Descending.

val startIndex: Int? = null

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

val userId: UUID? = null

Optional. Filter by user id.