TvShow

tmdb-js/sections/types. TvShow

A class that represents a specific TV show in TMDb.

Constructor

new TvShow(id, tvShowSection)

Initializes this object.
Source:
Parameters:
Name Type Description
id string The ID of the TV show.
tvShowSection exports.TvShowSection The parent TV show section.

Methods

(async) getAccountStatesAsync(sessionId, guestSessionId) → {Promise.<*>}

Gets the account states on the TV show in question. Only one of the IDs is allowed to be null or non-null in the same method call.
Source:
Parameters:
Name Type Description
sessionId string The session ID.
guestSessionId string The guest session ID.
Returns:
Type:
Promise.<*>
A Promise of account state data in JSON format.

(async) getAggregateCreditsAsync() → {Promise.<*>}

Gets aggregate credits data of this TV show.
Source:
Returns:
Type:
Promise.<*>
A Promise of aggregate credit data in JSON format.

(async) getAllEpisodesAsync() → {Promise.<Array.<exports.TvShowEpisode>>}

Gets all episodes of this TV show.
Source:
Returns:
Type:
Promise.<Array.<exports.TvShowEpisode>>
A Promise of an array containing TvShowEpisode objects.

(async) getAlternativeTitlesAsync() → {Promise.<*>}

Gets the alternative titles of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of alternative title data in JSON format.

(async) getChangesAsync(startDate, endDate, page) → {Promise.<*>}

Gets the changes of the TV show in question.
Source:
Parameters:
Name Type Default Description
startDate string The start date.
endDate string The end date.
page Number null The page.
Returns:
Type:
Promise.<*>
A Promise of JSON data with changes.

(async) getContentRatingsAsync() → {Promise.<*>}

Gets the content ratings of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of content rating data in JSON format.

(async) getCreditsAsync() → {Promise.<*>}

Gets the credits of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of credit data in JSON format.

(async) getDetailsAsync() → {Promise.<*>}

Gets all details about this TV show.
Source:
Returns:
Type:
Promise.<*>
A Promise of TV show details.

getEpisode(seasonNumber, episodeNumber) → {exports.TvShowEpisode}

Gets the specified episode of the specified season.
Source:
Parameters:
Name Type Description
seasonNumber Number The season number.
episodeNumber Number The episode number
Returns:
Type:
exports.TvShowEpisode
A TvShowEpisode object based on the passed season and episode numbers.

(async) getEpisodeGroupDataAsync() → {Promise.<*>}

Gets the episode groups of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of episode group data in JSON format.

(async) getExternalIdsAsync() → {Promise.<*>}

Gets the external IDs of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of external ID data in JSON format.

(async) getImagesAsync() → {Promise.<*>}

Gets the images of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of image data in JSON format.

(async) getKeywordsAsync() → {Promise.<*>}

Gets the keywords of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of keyword data in JSON format.

(async) getRecommendationsAsync(page) → {Promise.<*>}

Gets the recommendations based on the TV show in question.
Source:
Parameters:
Name Type Default Description
page Number null The page to get data from (see the API documentation for the range)
Returns:
Type:
Promise.<*>
A Promise of recommendation data in JSON format.

(async) getReviewsAsync(page) → {Promise.<*>}

Gets the reviews of the TV show in question.
Source:
Parameters:
Name Type Default Description
page Number null The page to get data from (see the API documentation for the range)
Returns:
Type:
Promise.<*>
A Promise of reviews in JSON format.

(async) getScreenedTheatricallyAsync() → {Promise.<*>}

Gets the a list of seasons or episodes of the TV show in question that were screened theatrically.
Source:
Returns:
Type:
Promise.<*>
A Promise of data about theatrically screened episodes or seasons in JSON format.

getSeason(seasonNumber) → {exports.TvShowSeason}

Gets the season with the passed number.
Source:
Parameters:
Name Type Description
seasonNumber Number The season number.
Returns:
Type:
exports.TvShowSeason
A TvShowSeason object.

(async) getSeasonCountAsync() → {Promise.<Number>}

Gets the number of seasons of this TV show.
Source:
Returns:
Type:
Promise.<Number>
A Promise of a season count.

(async) getSeasonsAsync() → {Promise.<Array.<exports.TvShowSeason>>}

Gets all seasons.
Source:
Returns:
Type:
Promise.<Array.<exports.TvShowSeason>>
A Promise of an array of TvShowSeason objects.

(async) getSimilarTvShowsAsync(page) → {Promise.<*>}

Gets the similar TV shows to the TV show in question.
Source:
Parameters:
Name Type Default Description
page Number null The page.
Returns:
Type:
Promise.<*>
A Promise of similar TV shows in JSON format.

(async) getTranslationsAsync() → {Promise.<*>}

Gets the translations of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of translation data in JSON format.

(async) getVideosAsync() → {Promise.<*>}

Gets the videos of the TV show in question.
Source:
Returns:
Type:
Promise.<*>
A Promise of video data in JSON format.