GetProgramsDto

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

Link copied to clipboard
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

Link copied to clipboard
val channelIds: List<UUID>? = null

The channels to return guide information for.

Link copied to clipboard
val enableImages: Boolean? = null

Include image information in output.

Link copied to clipboard

The image types to include in the output.

Link copied to clipboard

A value indicating whether retrieve total record count.

Link copied to clipboard
val enableUserData: Boolean? = null

Include user data.

Link copied to clipboard
val fields: List<ItemFields>? = null

Specify additional fields of information to return in the output.

Link copied to clipboard
val genreIds: List<UUID>? = null

The genre ids to return guide information for.

Link copied to clipboard
val genres: List<String>? = null

The genres to return guide information for.

Link copied to clipboard
val hasAired: Boolean? = null

Filter by programs that have completed airing, or not.

Link copied to clipboard
val imageTypeLimit: Int? = null

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

Link copied to clipboard
val isAiring: Boolean? = null

Filter by programs that are currently airing, or not.

Link copied to clipboard
val isKids: Boolean? = null

Filter for kids.

Link copied to clipboard
val isMovie: Boolean? = null

Filter for movies.

Link copied to clipboard
val isNews: Boolean? = null

Filter for news.

Link copied to clipboard
val isSeries: Boolean? = null

Filter for series.

Link copied to clipboard
val isSports: Boolean? = null

Filter for sports.

Link copied to clipboard
val librarySeriesId: UUID? = null

Filter by library series id.

Link copied to clipboard
val limit: Int? = null

The maximum number of records to return.

Link copied to clipboard
val maxEndDate: DateTime? = null

The maximum premiere end date.

Link copied to clipboard
val maxStartDate: DateTime? = null

The maximum premiere start date.

Link copied to clipboard
val minEndDate: DateTime? = null

The minimum premiere end date.

Link copied to clipboard
val minStartDate: DateTime? = null

The minimum premiere start date.

Link copied to clipboard
val seriesTimerId: String? = null

Filter by series timer id.

Link copied to clipboard
val sortBy: List<ItemSortBy>? = null

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

Link copied to clipboard
val sortOrder: List<SortOrder>? = null

Sort order.

Link copied to clipboard
val startIndex: Int? = null

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

Link copied to clipboard
val userId: UUID? = null

Optional. Filter by user id.