GenresApi

class GenresApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun getGenre(genreName: String, userId: UUID? = null): Response<BaseItemDto>

Gets a genre, by name.

Link copied to clipboard
suspend fun getGenres(request: GetGenresRequest = GetGenresRequest()): Response<BaseItemDtoQueryResult>
suspend fun getGenres(startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = emptyList(), excludeItemTypes: Collection<BaseItemKind>? = emptyList(), includeItemTypes: Collection<BaseItemKind>? = emptyList(), isFavorite: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), userId: UUID? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList(), enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets all genres from a given item, folder, or the entire library.