thetvdb v1.2.0 TheTVDB.Series

Link to this section Summary

Functions

Get all actors for a given series.

Get all episodes for a given series.

Determine if a given series exists.

Get info about a series.

Search for a series by IMDb ID.

Search for a series by name.

Search for a series by Zap2It ID.

Link to this section Types

Specs

t() :: %TheTVDB.Series{
  airs_day_of_week: term(),
  airs_time: term(),
  aliases: term(),
  banner: term(),
  first_aired: term(),
  genre: term(),
  id: term(),
  imdb_id: term(),
  last_updated: term(),
  network: term(),
  network_id: term(),
  overview: term(),
  rating: term(),
  runtime: term(),
  series_id: term(),
  series_name: term(),
  site_rating: term(),
  site_rating_count: term(),
  status: term(),
  zap2it_id: term()
}

Link to this section Functions

Link to this function

actors(series_id)

Specs

actors(integer()) :: {:ok, [TheTVDB.Series.Actor.t()]} | {:error, term()}

Get all actors for a given series.

Link to this function

actors!(series_id)

Specs

actors!(integer()) :: [TheTVDB.Series.Actor.t()]

See actors/1.

Link to this function

episodes(series_id)

Specs

episodes(integer()) ::
  {:ok, [TheTVDB.Series.BasicEpisode.t()]} | {:error, term()}

Get all episodes for a given series.

Link to this function

episodes!(series_id)

Specs

See episodes/1.

Specs

exists!(integer()) :: boolean()

See exists?/1.

Specs

exists?(integer()) :: {:ok, boolean()} | {:error, term()}

Determine if a given series exists.

Specs

info(integer()) :: {:ok, t()} | {:error, term()}

Get info about a series.

Specs

info!(integer()) :: t()

See info/1.

Link to this function

search_by_imdb_id(id)

Specs

search_by_imdb_id(binary() | integer()) ::
  {:ok, TheTVDB.Series.SearchResult.t()} | {:error, term()}

Search for a series by IMDb ID.

Link to this function

search_by_imdb_id!(id)

Specs

search_by_imdb_id!(binary() | integer()) :: TheTVDB.Series.SearchResult.t()

See search_by_imdb_id/1.

Link to this function

search_by_name(name)

Specs

search_by_name(String.t()) ::
  {:ok, [TheTVDB.Series.SearchResult.t()]} | {:error, term()}

Search for a series by name.

Link to this function

search_by_name!(name)

Specs

search_by_name!(String.t()) :: TheTVDB.Series.SearchResult.t()

See search_by_name/1.

Link to this function

search_by_zap2it_id(id)

Specs

search_by_zap2it_id(binary() | integer()) ::
  {:ok, TheTVDB.Series.SearchResult.t()} | {:error, term()}

Search for a series by Zap2It ID.

Link to this function

search_by_zap2it_id!(id)

Specs

search_by_zap2it_id!(binary() | integer()) :: TheTVDB.Series.SearchResult.t()

See search_by_zap2it_id/1.