ArtistsApi

class ArtistsApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun getAlbumArtists(request: <Error class: unknown class> = GetAlbumArtistsRequest()): Response<<Error class: unknown class>>
suspend fun getAlbumArtists(minCommunityRating: Double? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: <Error class: unknown class>? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), excludeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), includeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), filters: Collection<<Error class: unknown class>>? = emptyList(), isFavorite: Boolean? = null, mediaTypes: Collection<<Error class: unknown class>>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<<Error class: unknown class>>? = emptyList(), officialRatings: Collection<String>? = emptyList(), tags: Collection<String>? = emptyList(), years: Collection<Int>? = emptyList(), enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), person: String? = null, personIds: Collection<<Error class: unknown class>>? = emptyList(), personTypes: Collection<String>? = emptyList(), studios: Collection<String>? = emptyList(), studioIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList(), enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

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

Link copied to clipboard
suspend fun getArtistByName(name: String, userId: <Error class: unknown class>? = null): Response<<Error class: unknown class>>

Gets an artist by name.

Link copied to clipboard
suspend fun getArtists(request: <Error class: unknown class> = GetArtistsRequest()): Response<<Error class: unknown class>>
suspend fun getArtists(minCommunityRating: Double? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: <Error class: unknown class>? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), excludeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), includeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), filters: Collection<<Error class: unknown class>>? = emptyList(), isFavorite: Boolean? = null, mediaTypes: Collection<<Error class: unknown class>>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<<Error class: unknown class>>? = emptyList(), officialRatings: Collection<String>? = emptyList(), tags: Collection<String>? = emptyList(), years: Collection<Int>? = emptyList(), enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), person: String? = null, personIds: Collection<<Error class: unknown class>>? = emptyList(), personTypes: Collection<String>? = emptyList(), studios: Collection<String>? = emptyList(), studioIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList(), enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

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