GetRecordingsSeriesRequest

data class GetRecordingsSeriesRequest(val channelId: String? = null, val userId: UUID? = null, val groupId: String? = 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 enableTotalRecordCount: Boolean? = true)

Live tv recording series.

Constructors

Link copied to clipboard
constructor(channelId: String? = null, userId: UUID? = null, groupId: String? = 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, enableTotalRecordCount: Boolean? = true)

Properties

Link copied to clipboard
val channelId: String? = null

Optional. Filter by channel id.

Link copied to clipboard
val enableImages: Boolean? = null

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
val enableUserData: Boolean? = null

Optional. Include user data.

Link copied to clipboard

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

Link copied to clipboard
val groupId: String? = null

Optional. Filter by recording group.

Link copied to clipboard
val imageTypeLimit: Int? = null

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

Link copied to clipboard
val isInProgress: Boolean? = null

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

Link copied to clipboard
val limit: Int? = null

Optional. The maximum number of records to return.

Link copied to clipboard
val seriesTimerId: String? = null

Optional. Filter by recordings belonging to a series timer.

Link copied to clipboard
val startIndex: Int? = null

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

Link copied to clipboard
val status: RecordingStatus? = null

Optional. Filter by recording status.

Link copied to clipboard
val userId: UUID? = null

Optional. Filter by user and attach user data.