com.omertron.themoviedbapi.methods

Class TmdbTV

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbTV

public class TmdbTV
extends AbstractMethod

Class to hold the TV Methods

Author:

stuart.boston

Field Summary

Fields inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

Constructor and Description
TmdbTV(String apiKey, HttpTools httpTools) Constructor

Method Summary

Modifier and Type	Method and Description
TVInfo	getLatestTV() Get the latest TV show id.
MediaState	getTVAccountState(int tvID, String sessionID) This method lets users get the status of whether or not the TV show has been rated or added to their favourite or watch lists.
ResultList<TVInfo>	getTVAiringToday(Integer page, String language, String timezone) Get the list of TV shows that air today.
ResultList<AlternativeTitle>	getTVAlternativeTitles(int tvID) Get the alternative titles for a specific show ID.
ResultList<ChangeKeyItem>	getTVChanges(int tvID, String startDate, String endDate) Get the changes for a specific TV show id.
ResultList<ContentRating>	getTVContentRatings(int tvID) Get the content ratings for a specific TV show id.
MediaCreditList	getTVCredits(int tvID, String language) Get the cast & crew information about a TV series.
ExternalID	getTVExternalIDs(int tvID, String language) Get the external ids that we have stored for a TV series.
ResultList<Artwork>	getTVImages(int tvID, String language, String... includeImageLanguage) Get the images (posters and backdrops) for a TV series.
TVInfo	getTVInfo(int tvID, String language, String... appendToResponse) Get the primary information about a TV series by id.
ResultList<Keyword>	getTVKeywords(int tvID) Get the plot keywords for a specific TV show id.
ResultList<TVInfo>	getTVOnTheAir(Integer page, String language) Get the list of TV shows that are currently on the air.
ResultList<TVInfo>	getTVPopular(Integer page, String language) Get the list of popular TV shows.
ResultList<TVInfo>	getTVSimilar(int tvID, Integer page, String language) Get the similar TV shows for a specific tv id.
ResultList<TVInfo>	getTVTopRated(Integer page, String language) Get the list of top rated TV shows.
ResultList<Translation>	getTVTranslations(int tvID) Get the list of translations that exist for a TV series.
ResultList<Video>	getTVVideos(int tvID, String language) Get the videos that have been added to a TV series (trailers, opening credits, etc...)
StatusCode	postTVRating(int tvID, int rating, String sessionID, String guestSessionID) This method lets users rate a TV show.

Methods inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

getMediaChanges, getTypeReference, processWrapper, processWrapperList

Methods inherited from class java.lang.Object

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

Constructor Detail

TmdbTV

public TmdbTV(String apiKey,
              HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getTVInfo

public TVInfo getTVInfo(int tvID,
                        String language,
                        String... appendToResponse)
                 throws MovieDbException

Get the primary information about a TV series by id.

Parameters:

tvID -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getTVAccountState

public MediaState getTVAccountState(int tvID,
                                    String sessionID)
                             throws MovieDbException

This method lets users get the status of whether or not the TV show has been rated or added to their favourite or watch lists. A valid session id is required.

Parameters:

tvID -

sessionID -

Returns:

Throws:

MovieDbException

getTVAlternativeTitles

public ResultList<AlternativeTitle> getTVAlternativeTitles(int tvID)
                                                    throws MovieDbException

Get the alternative titles for a specific show ID.

Parameters:

tvID -

Returns:

Throws:

MovieDbException

getTVChanges

public ResultList<ChangeKeyItem> getTVChanges(int tvID,
                                              String startDate,
                                              String endDate)
                                       throws MovieDbException

Get the changes for a specific TV show id.

Parameters:

tvID -

startDate -

endDate -

Returns:

Throws:

MovieDbException

getTVContentRatings

public ResultList<ContentRating> getTVContentRatings(int tvID)
                                              throws MovieDbException

Get the content ratings for a specific TV show id.

Parameters:

tvID -

Returns:

Throws:

MovieDbException

getTVCredits

public MediaCreditList getTVCredits(int tvID,
                                    String language)
                             throws MovieDbException

Get the cast & crew information about a TV series.

Parameters:

tvID -

language -

Returns:

Throws:

MovieDbException

getTVExternalIDs

public ExternalID getTVExternalIDs(int tvID,
                                   String language)
                            throws MovieDbException

Get the external ids that we have stored for a TV series.

Parameters:

tvID -

language -

Returns:

Throws:

MovieDbException

getTVImages

public ResultList<Artwork> getTVImages(int tvID,
                                       String language,
                                       String... includeImageLanguage)
                                throws MovieDbException

Get the images (posters and backdrops) for a TV series.

Parameters:

tvID -

language -

includeImageLanguage -

Returns:

Throws:

MovieDbException

getTVKeywords

public ResultList<Keyword> getTVKeywords(int tvID)
                                  throws MovieDbException

Get the plot keywords for a specific TV show id.

Parameters:

tvID -

Returns:

Throws:

MovieDbException

postTVRating

public StatusCode postTVRating(int tvID,
                               int rating,
                               String sessionID,
                               String guestSessionID)
                        throws MovieDbException

This method lets users rate a TV show. A valid session id or guest session id is required.

Parameters:

tvID -

rating -

sessionID -

guestSessionID -

Returns:

Throws:

MovieDbException

getTVSimilar

public ResultList<TVInfo> getTVSimilar(int tvID,
                                       Integer page,
                                       String language)
                                throws MovieDbException

Get the similar TV shows for a specific tv id.

Parameters:

tvID -

page -

language -

Returns:

Throws:

MovieDbException

getTVTranslations

public ResultList<Translation> getTVTranslations(int tvID)
                                          throws MovieDbException

Get the list of translations that exist for a TV series. These translations cascade down to the episode level.

Parameters:

tvID -

Returns:

Throws:

MovieDbException

getTVVideos

public ResultList<Video> getTVVideos(int tvID,
                                     String language)
                              throws MovieDbException

Get the videos that have been added to a TV series (trailers, opening credits, etc...)

Parameters:

tvID -

language -

Returns:

Throws:

MovieDbException

getLatestTV

public TVInfo getLatestTV()
                   throws MovieDbException

Get the latest TV show id.

Returns:

Throws:

MovieDbException

getTVOnTheAir

public ResultList<TVInfo> getTVOnTheAir(Integer page,
                                        String language)
                                 throws MovieDbException

Get the list of TV shows that are currently on the air. This query looks for any TV show that has an episode with an air date in the next 7 days.

Parameters:

page -

language -

Returns:

Throws:

MovieDbException

getTVAiringToday

public ResultList<TVInfo> getTVAiringToday(Integer page,
                                           String language,
                                           String timezone)
                                    throws MovieDbException

Get the list of TV shows that air today. Without a specified timezone, this query defaults to EST

Parameters:

page -

language -

timezone -

Returns:

Throws:

MovieDbException

getTVTopRated

public ResultList<TVInfo> getTVTopRated(Integer page,
                                        String language)
                                 throws MovieDbException

Get the list of top rated TV shows. By default, this list will only include TV shows that have 2 or more votes. This list refreshes every day.

Parameters:

page -

language -

Returns:

Throws:

MovieDbException

getTVPopular

public ResultList<TVInfo> getTVPopular(Integer page,
                                       String language)
                                throws MovieDbException

Get the list of popular TV shows. This list refreshes every day.

Parameters:

page -

language -

Returns:

Throws:

MovieDbException