GetUpcomingEpisodesRequest

data class GetUpcomingEpisodesRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val parentId: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null)

A list of upcoming episodes.

Constructors

Link copied to clipboard
constructor(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, fields: Collection<ItemFields>? = null, parentId: UUID? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null)

Properties

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. 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
val limit: Int?

Optional. The maximum number of records to return.

Link copied to clipboard

Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

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
val userId: UUID?

The user id of the user to get the upcoming episodes for.