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

GetPersonsRequest

data class GetPersonsRequest(val limit: Int? = null, val searchTerm: String? = null, val fields: Collection<ItemFields>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val excludePersonTypes: Collection<String>? = null, val personTypes: Collection<String>? = null, val appearsInItemId: UUID? = null, val userId: UUID? = null, val enableImages: Boolean? = true)

All persons.

Constructors

Link copied to clipboard
constructor(limit: Int? = null, searchTerm: String? = null, fields: Collection<ItemFields>? = null, filters: Collection<ItemFilter>? = null, isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, excludePersonTypes: Collection<String>? = null, personTypes: Collection<String>? = null, appearsInItemId: UUID? = null, userId: UUID? = null, enableImages: Boolean? = true)

Properties

Link copied to clipboard
val appearsInItemId: UUID? = null

Optional. If specified, person results will be filtered on items related to said persons.

Link copied to clipboard
val enableImages: Boolean? = true

Optional, include image information in output.

Link copied to clipboard
val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

Link copied to clipboard
val enableUserData: Boolean? = null

Optional, include user data.

Link copied to clipboard
val excludePersonTypes: Collection<String>? = null

Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.

Link copied to clipboard
val fields: Collection<ItemFields>? = null

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

Link copied to clipboard
val filters: Collection<ItemFilter>? = null

Optional. Specify additional filters to apply.

Link copied to clipboard
val imageTypeLimit: Int? = null

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

Link copied to clipboard
val isFavorite: Boolean? = null

Optional filter by items that are marked as favorite, or not. userId is required.

Link copied to clipboard
val limit: Int? = null

Optional. The maximum number of records to return.

Link copied to clipboard
val personTypes: Collection<String>? = null

Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.

Link copied to clipboard
val searchTerm: String? = null

The search term.

Link copied to clipboard
val userId: UUID? = null

User id.