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

GetResumeItemsRequest

data class GetResumeItemsRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val mediaTypes: Collection<MediaType>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val enableTotalRecordCount: Boolean? = true, val enableImages: Boolean? = true, val excludeActiveSessions: Boolean? = false)

Items based on a query.

Constructors

constructor(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, mediaTypes: Collection<MediaType>? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, enableTotalRecordCount: Boolean? = true, enableImages: Boolean? = true, excludeActiveSessions: Boolean? = false)

Properties

enableImages

val enableImages: Boolean? = true

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

Optional. Enable the total record count.

enableUserData

val enableUserData: Boolean? = null

Optional. Include user data.

excludeActiveSessions

val excludeActiveSessions: Boolean? = false

Optional. Whether to exclude the currently active sessions.

excludeItemTypes

val excludeItemTypes: Collection<BaseItemKind>? = null

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

fields

val fields: Collection<ItemFields>? = null

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

imageTypeLimit

val imageTypeLimit: Int? = null

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

includeItemTypes

val includeItemTypes: Collection<BaseItemKind>? = null

Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.

limit

val limit: Int? = null

The item limit.

mediaTypes

val mediaTypes: Collection<MediaType>? = null

Optional. Filter by MediaType. Allows multiple, comma delimited.