Package com.amilesend.tvmaze.client.api

Class EpisodesApi

java.lang.Object

com.amilesend.tvmaze.client.api.ApiBase

com.amilesend.tvmaze.client.api.EpisodesApi

public class EpisodesApi
extends ApiBase

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Episode	getEpisode(int episodeId, boolean isShowIncluded)	Retrieves the episode for the given identifier.
List<CastMember>	getGuestCast(int episodeId)	Retrieves the list of guest cast members for an episode.
List<CrewMember>	getGuestCrew(int episodeId)	Retrieves the list of guest crew members for an episode.

Methods inherited from class java.lang.Object

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

Constructor Details

EpisodesApi

public EpisodesApi(Connection connection)

Creates a new EpisodesApi object.

Parameters:

connection - the connection

Method Details

getEpisode

public Episode getEpisode(int episodeId,
 boolean isShowIncluded)

Retrieves the episode for the given identifier.

Parameters:

episodeId - the episode identifier

isShowIncluded - if true, includes the embedded show information in the response; else, false

Returns:

the episode

See Also:

• Episode
• Show

getGuestCast

public List<CastMember> getGuestCast(int episodeId)

Retrieves the list of guest cast members for an episode.

Parameters:

episodeId - the episode identifier

Returns:

the list of guest cast members

See Also:

• CastMember

getGuestCrew

public List<CrewMember> getGuestCrew(int episodeId)

Retrieves the list of guest crew members for an episode.

Parameters:

episodeId - the episode identifier

Returns:

the list of guest crew members

See Also:

• CrewMember