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

GetArtistsRequest

data class GetArtistsRequest(val minCommunityRating: Double? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val studioIds: Collection<UUID>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)

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

Constructors

GetArtistsRequest

constructor(minCommunityRating: Double? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, filters: Collection<ItemFilter>? = null, isFavorite: Boolean? = null, mediaTypes: Collection<MediaType>? = null, genres: Collection<String>? = null, genreIds: Collection<UUID>? = null, officialRatings: Collection<String>? = null, tags: Collection<String>? = null, years: Collection<Int>? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, person: String? = null, personIds: Collection<UUID>? = null, personTypes: Collection<String>? = null, studios: Collection<String>? = null, studioIds: Collection<UUID>? = null, userId: UUID? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<ItemSortBy>? = null, sortOrder: Collection<SortOrder>? = null, enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true)

Properties

enableImages

val enableImages: Boolean? = true

Optional, include image information in output.

enableImageTypes

val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

enableTotalRecordCount

val enableTotalRecordCount: Boolean? = true

Total record count.

enableUserData

val enableUserData: Boolean? = null

Optional, include user data.

excludeItemTypes

val excludeItemTypes: Collection<BaseItemKind>? = null

Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

fields

val fields: Collection<ItemFields>? = null

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

filters

val filters: Collection<ItemFilter>? = null

Optional. Specify additional filters to apply.

genreIds

val genreIds: Collection<UUID>? = null

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

genres

val genres: Collection<String>? = null

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

imageTypeLimit

val imageTypeLimit: Int? = null

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

includeItemTypes

val includeItemTypes: Collection<BaseItemKind>? = null

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

isFavorite

val isFavorite: Boolean? = null

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

limit

val limit: Int? = null

Optional. The maximum number of records to return.

mediaTypes

val mediaTypes: Collection<MediaType>? = null

Optional filter by MediaType. Allows multiple, comma delimited.

minCommunityRating

val minCommunityRating: Double? = null

Optional filter by minimum community rating.

nameLessThan

val nameLessThan: String? = null

Optional filter by items whose name is equally or lesser than a given input string.

nameStartsWith

val nameStartsWith: String? = null

Optional filter by items whose name is sorted equally than a given input string.

nameStartsWithOrGreater

val nameStartsWithOrGreater: String? = null

Optional filter by items whose name is sorted equally or greater than a given input string.

officialRatings

val officialRatings: Collection<String>? = null

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

parentId

val parentId: UUID? = null

Specify this to localize the search to a specific item or folder. Omit to use the root.

person

val person: String? = null

Optional. If specified, results will be filtered to include only those containing the specified person.

personIds

val personIds: Collection<UUID>? = null

Optional. If specified, results will be filtered to include only those containing the specified person ids.

personTypes

val personTypes: Collection<String>? = null

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

searchTerm

val searchTerm: String? = null

Optional. Search term.

sortBy

val sortBy: Collection<ItemSortBy>? = null

Optional. Specify one or more sort orders, comma delimited.

sortOrder

val sortOrder: Collection<SortOrder>? = null

Sort Order - Ascending,Descending.

startIndex

val startIndex: Int? = null

Optional. The record index to start at. All items with a lower index will be dropped from the results.