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

GetGenresRequest

@Serializable

data class GetGenresRequest(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 isFavorite: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = 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 genres from a given item, folder, or the entire library.

Constructors

GetGenresRequest

constructor(startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, isFavorite: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = 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

@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.

enableTotalRecordCount

@SerialName(value = "enableTotalRecordCount")

val enableTotalRecordCount: Boolean?

Optional. Include total record count.

excludeItemTypes

@SerialName(value = "excludeItemTypes")

val excludeItemTypes: Collection<BaseItemKind>?

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

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

includeItemTypes

@SerialName(value = "includeItemTypes")

val includeItemTypes: Collection<BaseItemKind>?

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

@SerialName(value = "isFavorite")

val isFavorite: Boolean?

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

@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 is equally or lesser than a given input string.

@SerialName(value = "nameStartsWith")

val nameStartsWith: String?

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

nameStartsWithOrGreater

@SerialName(value = "nameStartsWithOrGreater")

val nameStartsWithOrGreater: String?

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

@SerialName(value = "parentId")

val parentId: UUID?

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

@SerialName(value = "searchTerm")

val searchTerm: String?

The search term.

@SerialName(value = "sortBy")

val sortBy: Collection<ItemSortBy>?

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

@SerialName(value = "sortOrder")

val sortOrder: Collection<SortOrder>?

Sort Order - Ascending,Descending.

@SerialName(value = "startIndex")

val startIndex: Int?

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

@SerialName(value = "userId")

val userId: UUID?

User id.