model-film/com.flixclusive.model.film/FilmSearchItem

FilmSearchItem

@Serializable
data class FilmSearchItem(val id: String?, val providerId: String, val filmType: FilmType, val homePage: String?, val title: String, val posterImage: String?, val adult: Boolean = false, val backdropImage: String? = null, val imdbId: String? = null, val tmdbId: Int? = null, val releaseDate: String? = null, val rating: Double? = null, val language: String? = null, val overview: String? = null, val year: Int? = null, val logoImage: String? = null, val genres: List<Genre> = emptyList(), val customProperties: Map<String, String?> = emptyMap(), val voteCount: Int = 0, val genreIds: List<Int> = emptyList()) : Film(source)

Represents a film search result item.

See also

Constructors

Link copied to clipboard
constructor(id: String?, providerId: String, filmType: FilmType, homePage: String?, title: String, posterImage: String?, adult: Boolean = false, backdropImage: String? = null, imdbId: String? = null, tmdbId: Int? = null, releaseDate: String? = null, rating: Double? = null, language: String? = null, overview: String? = null, year: Int? = null, logoImage: String? = null, genres: List<Genre> = emptyList(), customProperties: Map<String, String?> = emptyMap(), voteCount: Int = 0, genreIds: List<Int> = emptyList())

Properties

Link copied to clipboard
open override val adult: Boolean = false

Whether the film is marked as adult. Defaults to false.

Link copied to clipboard
open override val backdropImage: String? = null

The URL of the film's backdrop image.

Link copied to clipboard
open override val customProperties: Map<String, String?>

A map of custom properties associated with the film. Add any properties that your response/resource needs. Also, serialize the value of the property to string.

Link copied to clipboard
open override val filmType: FilmType
Link copied to clipboard
val genreIds: List<Int>

A list of genre IDs associated with the film.

Link copied to clipboard
open override val genres: List<Genre>

A list of genres associated with the film.

Link copied to clipboard
open override val homePage: String?

The URL of the film's home page.

Link copied to clipboard
open override val id: String?

The unique identifier for the film.

Link copied to clipboard
val identifier: String

A unique identifier for the film. It could either be id, tmdbId, imdbId, or title in the following sequential order.

Link copied to clipboard
open override val imdbId: String? = null

The IMDB ID of the film.

Link copied to clipboard
val isFromTmdb: Boolean

Indicates whether the film is from TMDB (optional).

Link copied to clipboard
open override val language: String? = null

The language of the film.

Link copied to clipboard
open override val logoImage: String? = null

The URL of the film's logo image.

Link copied to clipboard
open override val overview: String? = null

The overview of the film.

Link copied to clipboard
open val parsedReleaseDate: String?

The parsed release date of the film in a consistent format.

Link copied to clipboard
open override val posterImage: String?

The URL of the film's poster image.

Link copied to clipboard
open override val providerId: String

The provider id of the provider this film came from.

Link copied to clipboard
open override val rating: Double? = null

The rating of the film. Defaults to 0.0.

Link copied to clipboard
open val recommendations: List<FilmSearchItem>

A list of recommended films.

Link copied to clipboard
open override val releaseDate: String? = null

The release date of the film.

Link copied to clipboard
Link copied to clipboard
open val runtime: Int?

The runtime of the film in minutes.

Link copied to clipboard
open override val title: String

The title of the film.

Link copied to clipboard
open override val tmdbId: Int? = null

The TMDB ID of the film.

Link copied to clipboard
val voteCount: Int = 0

The vote count of the film.

Link copied to clipboard
open override val year: Int? = null

The release year of the film.