GetResumeItemsRequest

@Serializable
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

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

Link copied to clipboard
@SerialName(value = "enableImages")
val enableImages: Boolean?

Optional. Include image information in output.

Link copied to clipboard
@SerialName(value = "enableImageTypes")
val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

Link copied to clipboard
@SerialName(value = "enableTotalRecordCount")
val enableTotalRecordCount: Boolean?

Optional. Enable the total record count.

Link copied to clipboard
@SerialName(value = "enableUserData")
val enableUserData: Boolean?

Optional. Include user data.

Link copied to clipboard
@SerialName(value = "excludeActiveSessions")
val excludeActiveSessions: Boolean?

Optional. Whether to exclude the currently active sessions.

Link copied to clipboard
@SerialName(value = "excludeItemTypes")
val excludeItemTypes: Collection<BaseItemKind>?

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

Link copied to clipboard
@SerialName(value = "fields")
val fields: Collection<ItemFields>?

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.

Link copied to clipboard
@SerialName(value = "imageTypeLimit")
val imageTypeLimit: Int?

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

Link copied to clipboard
@SerialName(value = "includeItemTypes")
val includeItemTypes: Collection<BaseItemKind>?

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

Link copied to clipboard
@SerialName(value = "limit")
val limit: Int?

The item limit.

Link copied to clipboard
@SerialName(value = "mediaTypes")
val mediaTypes: Collection<MediaType>?

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

Link copied to clipboard
@SerialName(value = "parentId")
val parentId: UUID?

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

Link copied to clipboard
@SerialName(value = "searchTerm")
val searchTerm: String?

The search term.

Link copied to clipboard
@SerialName(value = "startIndex")
val startIndex: Int?

The start index.

Link copied to clipboard
@SerialName(value = "userId")
val userId: UUID?

The user id.