Package com.amilesend.tvmaze.client.api

Class ShowsApi

java.lang.Object

com.amilesend.tvmaze.client.api.ApiBase

com.amilesend.tvmaze.client.api.ShowsApi

public class ShowsApi
extends ApiBase

TVMaze API to retrieve show information.
For more information, please refer to https://www.tvmaze.com/api#shows

Constructor Summary

Constructors

Constructor	Description
ShowsApi(Connection connection)	Creates a new ShowsApi object.

Method Summary

Modifier and Type	Method	Description
List<Alias>	getAliases(int showId)	Gets the list of alternative show names, or aliases.
CompletableFuture<List<Alias>>	getAliasesAsync(int showId)	Gets the list of alternative show names, or aliases.
List<AlternateEpisode>	getAlternateEpisodes(int alternateListId, boolean isEpisodesIncluded)	Gets the list of alternate episodes for the given alternateListId.
CompletableFuture<List<AlternateEpisode>>	getAlternateEpisodesAsync(int alternateListId, boolean isEpisodesIncluded)	Gets the list of alternate episodes for the given alternateListId.
AlternateList	getAlternateList(int alternateListId, boolean isAlternateEpisodesIncluded)	Gets the alternate episode list for the given alternateListId.
CompletableFuture<AlternateList>	getAlternateListAsync(int alternateListId, boolean isAlternateEpisodesIncluded)	Gets the alternate episode list for the given alternateListId.
List<AlternateList>	getAlternateLists(int showId)	Gets the list of alternate episode lists for the given showId (e.g., DVD ordering).
CompletableFuture<List<AlternateList>>	getAlternateListsAsync(int showId)	Gets the list of alternate episode lists for the given showId (e.g., DVD ordering).
List<CastMember>	getCast(int showId)	Gets the list of cast members for a show.
CompletableFuture<List<CastMember>>	getCastAsync(int showId)	Gets the list of cast members for a show.
List<CrewMember>	getCrew(int showId)	Gets the list of crew members for a show.
CompletableFuture<List<CrewMember>>	getCrewAsync(int showId)	Gets the list of crew members for a show.
Episode	getEpisode(int showId, int seasonNum, int episodeNum)	Gets an Episode for the given show, season, and episode number.
CompletableFuture<Episode>	getEpisodeAsync(int showId, int seasonNum, int episodeNum)	Gets an Episode for the given show, season, and episode number.
List<Episode>	getEpisodes(int showId, boolean isSpecialsIncluded)	Gets the list of episodes for the given showId.
List<Episode>	getEpisodes(int showId, LocalDate date)	Gets the list of episodes for a show that aired on the given date.
CompletableFuture<List<Episode>>	getEpisodesAsync(int showId, boolean isSpecialsIncluded)	Gets the list of episodes for the given showId.
CompletableFuture<List<Episode>>	getEpisodesAsync(int showId, LocalDate date)	Gets the list of episodes for a show that aired on the given date.
List<Image>	getImages(int showId)	Gets the list of images for a show.
CompletableFuture<List<Image>>	getImagesAsync(int showId)	Gets the list of images for a show.
List<Show>	getIndex(int pageNum)	Gets the list of all shows in the TVMaze database.
CompletableFuture<List<Show>>	getIndexAsync(int pageNum)	Gets the list of all shows in the TVMaze database.
List<Episode>	getSeasonEpisodes(int seasonId, boolean isGuestCastIncluded)	Gets the list of episodes for a given seasonId.
CompletableFuture<List<Episode>>	getSeasonEpisodesAsync(int seasonId, boolean isGuestCastIncluded)	Gets the list of episodes for a given seasonId.
List<Season>	getSeasons(int showId)	Gets the list of seasons for a show.
CompletableFuture<List<Season>>	getSeasonsAsync(int showId)	Gets the list of seasons for a show.
Show	getShow(int showId, Show.EmbeddedType... includeEmbeddedTypes)	Gets the show for the given showId.
CompletableFuture<Show>	getShowAsync(int showId, Show.EmbeddedType... includeEmbeddedTypes)	Gets the show for the given showId.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShowsApi

public ShowsApi(Connection connection)

Creates a new ShowsApi object.

Parameters:

connection - the connection

Method Details

getShow

public Show getShow(int showId,
 Show.EmbeddedType... includeEmbeddedTypes)

Gets the show for the given showId.

Parameters:

showId - the show identifier

includeEmbeddedTypes - the optional embedded types to include in the show

Returns:

the show

See Also:

• Show

getShowAsync

public CompletableFuture<Show> getShowAsync(int showId,
 Show.EmbeddedType... includeEmbeddedTypes)

Gets the show for the given showId.

Parameters:

showId - the show identifier

includeEmbeddedTypes - the optional embedded types to include in the show

Returns:

the completable future that retrieves the show

See Also:

• Show

getEpisodes

public List<Episode> getEpisodes(int showId,
 boolean isSpecialsIncluded)

Gets the list of episodes for the given showId.

Parameters:

showId - the show identifier

isSpecialsIncluded - if true, include specials in the list; else false

Returns:

the list of episodes

getEpisodesAsync

public CompletableFuture<List<Episode>> getEpisodesAsync(int showId,
 boolean isSpecialsIncluded)

Gets the list of episodes for the given showId.

Parameters:

showId - the show identifier

isSpecialsIncluded - if true, include specials in the list; else false

Returns:

the completable future that retrieves the list of episodes

getAlternateLists

public List<AlternateList> getAlternateLists(int showId)

Gets the list of alternate episode lists for the given showId (e.g., DVD ordering).

Parameters:

showId - the show identifier

Returns:

the list of alternate episodes lists

See Also:

• AlternateList

getAlternateListsAsync

public CompletableFuture<List<AlternateList>> getAlternateListsAsync(int showId)

Gets the list of alternate episode lists for the given showId (e.g., DVD ordering).

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of alternate episodes lists

See Also:

• AlternateList

getAlternateList

public AlternateList getAlternateList(int alternateListId,
 boolean isAlternateEpisodesIncluded)

Gets the alternate episode list for the given alternateListId.

Parameters:

alternateListId - the alternate episode list

isAlternateEpisodesIncluded - if true, includes the list of embedded alternate episodes; else, false

Returns:

the alternate episode list

See Also:

• AlternateList

getAlternateListAsync

public CompletableFuture<AlternateList> getAlternateListAsync(int alternateListId,
 boolean isAlternateEpisodesIncluded)

Gets the alternate episode list for the given alternateListId.

Parameters:

alternateListId - the alternate episode list

isAlternateEpisodesIncluded - if true, includes the list of embedded alternate episodes; else, false

Returns:

the completable future that retrieves the alternate episode list

See Also:

• AlternateList

getAlternateEpisodes

public List<AlternateEpisode> getAlternateEpisodes(int alternateListId,
 boolean isEpisodesIncluded)

Gets the list of alternate episodes for the given alternateListId.

Parameters:

alternateListId - the alternate list identifier

isEpisodesIncluded - if true, includes the associated Episode; else, false

Returns:

the list of alternate episodes

See Also:

• AlternateEpisode

getAlternateEpisodesAsync

public CompletableFuture<List<AlternateEpisode>> getAlternateEpisodesAsync(int alternateListId,
 boolean isEpisodesIncluded)

Gets the list of alternate episodes for the given alternateListId.

Parameters:

alternateListId - the alternate list identifier

isEpisodesIncluded - if true, includes the associated Episode; else, false

Returns:

the completable future that retrieves the list of alternate episodes

See Also:

• AlternateEpisode

getEpisode

public Episode getEpisode(int showId,
 int seasonNum,
 int episodeNum)

Gets an Episode for the given show, season, and episode number.

Parameters:

showId - the show identifier

seasonNum - the season number

episodeNum - the associated episode number for the season

Returns:

the episode

See Also:

• Episode

getEpisodeAsync

public CompletableFuture<Episode> getEpisodeAsync(int showId,
 int seasonNum,
 int episodeNum)

Gets an Episode for the given show, season, and episode number.

Parameters:

showId - the show identifier

seasonNum - the season number

episodeNum - the associated episode number for the season

Returns:

the completable future that retrieves the episode

See Also:

• Episode

getEpisodes

public List<Episode> getEpisodes(int showId,
 LocalDate date)

Gets the list of episodes for a show that aired on the given date.

Parameters:

showId - the show identifier

date - the date of airing

Returns:

the list of episodes

See Also:

• Episode

getEpisodesAsync

public CompletableFuture<List<Episode>> getEpisodesAsync(int showId,
 LocalDate date)

Gets the list of episodes for a show that aired on the given date.

Parameters:

showId - the show identifier

date - the date of airing

Returns:

the completable future that retrieves the list of episodes

See Also:

• Episode

getSeasons

public List<Season> getSeasons(int showId)

Gets the list of seasons for a show.

Parameters:

showId - the show identifier

Returns:

the list of seasons

See Also:

• Season

getSeasonsAsync

public CompletableFuture<List<Season>> getSeasonsAsync(int showId)

Gets the list of seasons for a show.

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of seasons

See Also:

• Season

getSeasonEpisodes

public List<Episode> getSeasonEpisodes(int seasonId,
 boolean isGuestCastIncluded)

Gets the list of episodes for a given seasonId.

Parameters:

seasonId - the season identifier

isGuestCastIncluded - if true, returns the list of guest cast members; else false

Returns:

the list of episodes

See Also:

• Episode

getSeasonEpisodesAsync

public CompletableFuture<List<Episode>> getSeasonEpisodesAsync(int seasonId,
 boolean isGuestCastIncluded)

Gets the list of episodes for a given seasonId.

Parameters:

seasonId - the season identifier

isGuestCastIncluded - if true, returns the list of guest cast members; else false

Returns:

the completable future that retrieves the list of episodes

See Also:

• Episode

getCast

public List<CastMember> getCast(int showId)

Gets the list of cast members for a show.

Parameters:

showId - the show identifier

Returns:

the list of cast members

See Also:

• CastMember

getCastAsync

public CompletableFuture<List<CastMember>> getCastAsync(int showId)

Gets the list of cast members for a show.

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of cast members

See Also:

• CastMember

getCrew

public List<CrewMember> getCrew(int showId)

Gets the list of crew members for a show.

Parameters:

showId - the show identifier

Returns:

the list of crew members

See Also:

• CrewMember

getCrewAsync

public CompletableFuture<List<CrewMember>> getCrewAsync(int showId)

Gets the list of crew members for a show.

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of crew members

See Also:

• CrewMember

getAliases

public List<Alias> getAliases(int showId)

Gets the list of alternative show names, or aliases.

Parameters:

showId - the show identifier

Returns:

the list of aliases

See Also:

• Alias

getAliasesAsync

public CompletableFuture<List<Alias>> getAliasesAsync(int showId)

Gets the list of alternative show names, or aliases.

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of aliases

See Also:

• Alias

getImages

public List<Image> getImages(int showId)

Gets the list of images for a show.

Parameters:

showId - the show identifier

Returns:

the list of images

See Also:

• Image

getImagesAsync

public CompletableFuture<List<Image>> getImagesAsync(int showId)

Gets the list of images for a show.

Parameters:

showId - the show identifier

Returns:

the completable future that retrieves the list of images

See Also:

• Image

getIndex

public List<Show> getIndex(int pageNum)

Gets the list of all shows in the TVMaze database. Note: This is paginated and requires manual specification of the page number with a maximum of 250 shows per response. This operation will throw a RequestException when no more pages exist.

Parameters:

pageNum - the page number

Returns:

the list of shows

Throws:

RequestException - if there are no more shows to return

getIndexAsync

public CompletableFuture<List<Show>> getIndexAsync(int pageNum)

Gets the list of all shows in the TVMaze database. Note: This is paginated and requires manual specification of the page number with a maximum of 250 shows per response. This operation will throw a RequestException when no more pages exist.

Parameters:

pageNum - the page number

Returns:

the completable future that retrieves the list of shows

Throws:

RequestException - if there are no more shows to return