@theoplayer/react-native-engage/src/api/entities/TvEpisode.ts

Engage connector for @theoplayer/react-native

import { ClusterEntity, EntityType } from './Entity';
import { Availability, PlatformUri, Price, RatingSystem } from '../types';

/**
 * An object representing a tv episode.
 *
 * {@link https://developer.android.com/guide/playcore/engage/watch#tvepisodeentity | TvEpisodeEntity}.
 */
export interface TvEpisode extends ClusterEntity {
  /**
   * The entity type.
   */
  type: EntityType.TvEpisode;

  /**
   * The deep link to the provider app to start playing the entity.
   */
  playbackUri: string;

  /**
   * The air date of the episode, in epoch milliseconds.
   */
  airDate: number;

  /**
   * The availability of the entity.
   */
  availability: Availability;

  /**
   * Duration in milliseconds.
   */
  duration: number;

  /**
   * A list of genres.
   */
  genres: string[];

  /**
   * A list of content ratings.
   */
  contentRating: RatingSystem[];

  /**
   * A list of platform-specific deep links to the provider app to start playing the entity.
   */
  platformSpecificPlaybackUri?: PlatformUri[];

  /**
   * The deep link to the provider app to show details about the entity.
   */
  infoPageUri?: string;

  /**
   * The show title.
   */
  showTitle?: string;

  /**
   * The season title.
   */
  seasonTitle?: string;

  /**
   * The season number as a string.
   */
  seasonNumber?: string;

  /**
   * The episode number.
   */
  episodeNumber?: number;

  /**
   * The episode number as a string that can be displayed.
   */
  episodeDisplayNumber?: string;

  /**
   * The entity's price.
   */
  price?: Price;

  /**
   * Whether the entity was downloaded on the device for offline viewing.
   */
  downloadedOnDevice?: boolean;

  /**
   * Whether the next episode is already available.
   */
  isNextEpisodeAvailable?: boolean;
}