jellyfin-model/org.jellyfin.sdk.model.api/SearchHint

SearchHint

@Serializable

data class SearchHint(val itemId: UUID, val id: UUID, val name: String, val matchedTerm: String? = null, val indexNumber: Int? = null, val productionYear: Int? = null, val parentIndexNumber: Int? = null, val primaryImageTag: String? = null, val thumbImageTag: String? = null, val thumbImageItemId: String? = null, val backdropImageTag: String? = null, val backdropImageItemId: String? = null, val type: BaseItemKind, val isFolder: Boolean? = null, val runTimeTicks: Long? = null, val mediaType: MediaType = MediaType.UNKNOWN, val startDate: DateTime? = null, val endDate: DateTime? = null, val series: String? = null, val status: String? = null, val album: String? = null, val albumId: UUID? = null, val albumArtist: String? = null, val artists: List<String>, val songCount: Int? = null, val episodeCount: Int? = null, val channelId: UUID? = null, val channelName: String? = null, val primaryImageAspectRatio: Double? = null)

Class SearchHintResult.

Constructors

constructor(itemId: UUID, id: UUID, name: String, matchedTerm: String? = null, indexNumber: Int? = null, productionYear: Int? = null, parentIndexNumber: Int? = null, primaryImageTag: String? = null, thumbImageTag: String? = null, thumbImageItemId: String? = null, backdropImageTag: String? = null, backdropImageItemId: String? = null, type: BaseItemKind, isFolder: Boolean? = null, runTimeTicks: Long? = null, mediaType: MediaType = MediaType.UNKNOWN, startDate: DateTime? = null, endDate: DateTime? = null, series: String? = null, status: String? = null, album: String? = null, albumId: UUID? = null, albumArtist: String? = null, artists: List<String>, songCount: Int? = null, episodeCount: Int? = null, channelId: UUID? = null, channelName: String? = null, primaryImageAspectRatio: Double? = null)

Properties

@SerialName(value = "Album")

val album: String?

The album.

@SerialName(value = "AlbumArtist")

val albumArtist: String?

The album artist.

@SerialName(value = "AlbumId")

val albumId: UUID?

The album id.

@SerialName(value = "Artists")

val artists: List<String>

The artists.

backdropImageItemId

@SerialName(value = "BackdropImageItemId")

val backdropImageItemId: String?

The backdrop image item identifier.

backdropImageTag

@SerialName(value = "BackdropImageTag")

val backdropImageTag: String?

The backdrop image tag.

@SerialName(value = "ChannelId")

val channelId: UUID?

The channel identifier.

@SerialName(value = "ChannelName")

val channelName: String?

The name of the channel.

@SerialName(value = "EndDate")

val endDate: DateTime?

The end date.

@SerialName(value = "EpisodeCount")

val episodeCount: Int?

The episode count.

@SerialName(value = "Id")

val id: UUID

The item id.

@SerialName(value = "IndexNumber")

val indexNumber: Int?

The index number.

@SerialName(value = "IsFolder")

val isFolder: Boolean?

A value indicating whether this instance is folder.

@SerialName(value = "ItemId")

val ~~itemId~~: UUID

The item id.

@SerialName(value = "MatchedTerm")

val matchedTerm: String?

The matched term.

@SerialName(value = "MediaType")

val mediaType: MediaType

The type of the media.

@SerialName(value = "Name")

val name: String

The name.

parentIndexNumber

@SerialName(value = "ParentIndexNumber")

val parentIndexNumber: Int?

The parent index number.

primaryImageAspectRatio

@SerialName(value = "PrimaryImageAspectRatio")

val primaryImageAspectRatio: Double?

The primary image aspect ratio.

primaryImageTag

@SerialName(value = "PrimaryImageTag")

val primaryImageTag: String?

The image tag.

@SerialName(value = "ProductionYear")

val productionYear: Int?

The production year.

@SerialName(value = "RunTimeTicks")

val runTimeTicks: Long?

The run time ticks.

@SerialName(value = "Series")

val series: String?

The series.

@SerialName(value = "SongCount")

val songCount: Int?

The song count.

@SerialName(value = "StartDate")

val startDate: DateTime?

The start date.

@SerialName(value = "Status")

val status: String?

The status.

thumbImageItemId

@SerialName(value = "ThumbImageItemId")

val thumbImageItemId: String?

The thumb image item identifier.

@SerialName(value = "ThumbImageTag")

val thumbImageTag: String?

The thumb image tag.

@SerialName(value = "Type")

val type: BaseItemKind

The type.