GetRecordingsRequest

data class GetRecordingsRequest(val channelId: String? = null, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val status: RecordingStatus? = null, val isInProgress: Boolean? = null, val seriesTimerId: String? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val isNews: Boolean? = null, val isLibraryItem: Boolean? = null, val enableTotalRecordCount: Boolean? = true)

Live tv recordings.

Constructors

Link copied to clipboard
constructor(channelId: String? = null, userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, status: RecordingStatus? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, fields: Collection<ItemFields>? = null, enableUserData: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, isNews: Boolean? = null, isLibraryItem: Boolean? = null, enableTotalRecordCount: Boolean? = true)

Properties

Link copied to clipboard

Optional. Filter by channel id.

Link copied to clipboard

Optional. Include image information in output.

Link copied to clipboard

Optional. The image types to include in the output.

Link copied to clipboard

Optional. Return total record count.

Link copied to clipboard

Optional. Include user data.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Optional. Filter by recordings that are in progress, or not.

Link copied to clipboard

Optional. Filter for kids.

Link copied to clipboard

Optional. Filter for is library item.

Link copied to clipboard

Optional. Filter for movies.

Link copied to clipboard

Optional. Filter for news.

Link copied to clipboard

Optional. Filter for series.

Link copied to clipboard

Optional. Filter for sports.

Link copied to clipboard
val limit: Int?

Optional. The maximum number of records to return.

Link copied to clipboard

Optional. Filter by recordings belonging to a series timer.

Link copied to clipboard

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

Link copied to clipboard

Optional. Filter by recording status.

Link copied to clipboard
val userId: UUID?

Optional. Filter by user and attach user data.