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

GetPersonsRequest

@Serializable

data class GetPersonsRequest(val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val nameStartsWithOrGreater: 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 parentId: UUID? = null, val appearsInItemId: UUID? = null, val userId: UUID? = null, val enableImages: Boolean? = true)

All persons.

Constructors

GetPersonsRequest

constructor(startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, nameStartsWithOrGreater: 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, parentId: UUID? = null, appearsInItemId: UUID? = null, userId: UUID? = null, enableImages: Boolean? = true)

Properties

appearsInItemId

@SerialName(value = "appearsInItemId")

val appearsInItemId: UUID?

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

@SerialName(value = "enableImages")

val enableImages: Boolean?

Optional, include image information in output.

enableImageTypes

@SerialName(value = "enableImageTypes")

val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional, include user data.

excludePersonTypes

@SerialName(value = "excludePersonTypes")

val excludePersonTypes: Collection<String>?

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

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

@SerialName(value = "filters")

val filters: Collection<ItemFilter>?

Optional. Specify additional filters to apply.

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

@SerialName(value = "isFavorite")

val isFavorite: Boolean?

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

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "nameLessThan")

val nameLessThan: String?

Optional. Filter by items whose name will appear before this value when sorted alphabetically.

@SerialName(value = "nameStartsWith")

val nameStartsWith: String?

Optional. Filter by items whose name starts with the given input string.

nameStartsWithOrGreater

@SerialName(value = "nameStartsWithOrGreater")

val nameStartsWithOrGreater: String?

Optional. Filter by items whose name will appear after this value when sorted alphabetically.

@SerialName(value = "parentId")

val parentId: UUID?

Optional. Specify this to localize the search to a specific library. Omit to use the root.

@SerialName(value = "personTypes")

val personTypes: Collection<String>?

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

@SerialName(value = "searchTerm")

val searchTerm: String?

The search term.

@SerialName(value = "startIndex")

val startIndex: Int?

Optional. All items with a lower index will be dropped from the response.

@SerialName(value = "userId")

val userId: UUID?

User id.