jellyfin-api/org.jellyfin.sdk.api.operations/PersonsApi

PersonsApi

class PersonsApi(api: ApiClient) : Api

Constructors

constructor(api: ApiClient)

Functions

suspend fun getPerson(name: String, userId: UUID? = null): Response<BaseItemDto>

Get person by name.

suspend fun getPersons(request: GetPersonsRequest = GetPersonsRequest()): Response<BaseItemDtoQueryResult>

suspend fun getPersons(limit: Int? = null, searchTerm: String? = null, fields: Collection<ItemFields>? = emptyList(), filters: Collection<ItemFilter>? = emptyList(), isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), excludePersonTypes: Collection<String>? = emptyList(), personTypes: Collection<String>? = emptyList(), appearsInItemId: UUID? = null, userId: UUID? = null, enableImages: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets all persons.