com.omertron.themoviedbapi.methods

Class TmdbEpisodes

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbEpisodes

public class TmdbEpisodes
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
TmdbEpisodes(String apiKey, HttpTools httpTools) Constructor

Method Summary

Modifier and Type	Method and Description
MediaState	getEpisodeAccountState(int tvID, int seasonNumber, int episodeNumber, String sessionID) This method lets users get the status of whether or not the TV episode has been rated.
ResultList<ChangeKeyItem>	getEpisodeChanges(int episodeID, String startDate, String endDate) Look up a TV episode's changes by episode ID
MediaCreditList	getEpisodeCredits(int tvID, int seasonNumber, int episodeNumber) Get the TV episode credits by combination of season and episode number.
ExternalID	getEpisodeExternalID(int tvID, int seasonNumber, int episodeNumber, String language) Get the external ids for a TV episode by comabination of a season and episode number.
ResultList<Artwork>	getEpisodeImages(int tvID, int seasonNumber, int episodeNumber) Get the images (episode stills) for a TV episode by combination of a season and episode number.
TVEpisodeInfo	getEpisodeInfo(int tvID, int seasonNumber, int episodeNumber, String language, String... appendToResponse) Get the primary information about a TV episode by combination of a season and episode number.
ResultList<Video>	getEpisodeVideos(int tvID, int seasonNumber, int episodeNumber, String language) Get the videos that have been added to a TV episode (teasers, clips, etc...)
StatusCode	postEpisodeRating(int tvID, int seasonNumber, int episodeNumber, int rating, String sessionID, String guestSessionID) This method lets users rate a TV episode.

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

TmdbEpisodes

public TmdbEpisodes(String apiKey,
                    HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getEpisodeInfo

public TVEpisodeInfo getEpisodeInfo(int tvID,
                                    int seasonNumber,
                                    int episodeNumber,
                                    String language,
                                    String... appendToResponse)
                             throws MovieDbException

Get the primary information about a TV episode by combination of a season and episode number.

Parameters:

tvID -

seasonNumber -

episodeNumber -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getEpisodeChanges

public ResultList<ChangeKeyItem> getEpisodeChanges(int episodeID,
                                                   String startDate,
                                                   String endDate)
                                            throws MovieDbException

Look up a TV episode's changes by episode ID

Parameters:

episodeID -

startDate -

endDate -

Returns:

Throws:

MovieDbException

getEpisodeAccountState

public MediaState getEpisodeAccountState(int tvID,
                                         int seasonNumber,
                                         int episodeNumber,
                                         String sessionID)
                                  throws MovieDbException

This method lets users get the status of whether or not the TV episode has been rated. A valid session id is required.

Parameters:

tvID -

seasonNumber -

episodeNumber -

sessionID -

Returns:

Throws:

MovieDbException

getEpisodeCredits

public MediaCreditList getEpisodeCredits(int tvID,
                                         int seasonNumber,
                                         int episodeNumber)
                                  throws MovieDbException

Get the TV episode credits by combination of season and episode number.

Parameters:

tvID -

seasonNumber -

episodeNumber -

Returns:

Throws:

MovieDbException

getEpisodeExternalID

public ExternalID getEpisodeExternalID(int tvID,
                                       int seasonNumber,
                                       int episodeNumber,
                                       String language)
                                throws MovieDbException

Get the external ids for a TV episode by comabination of a season and episode number.

Parameters:

tvID -

seasonNumber -

episodeNumber -

language -

Returns:

Throws:

MovieDbException

getEpisodeImages

public ResultList<Artwork> getEpisodeImages(int tvID,
                                            int seasonNumber,
                                            int episodeNumber)
                                     throws MovieDbException

Get the images (episode stills) for a TV episode by combination of a season and episode number.

Parameters:

tvID -

seasonNumber -

episodeNumber -

Returns:

Throws:

MovieDbException

postEpisodeRating

public StatusCode postEpisodeRating(int tvID,
                                    int seasonNumber,
                                    int episodeNumber,
                                    int rating,
                                    String sessionID,
                                    String guestSessionID)
                             throws MovieDbException

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

Parameters:

tvID -

seasonNumber -

episodeNumber -

rating -

sessionID -

guestSessionID -

Returns:

Throws:

MovieDbException

getEpisodeVideos

public ResultList<Video> getEpisodeVideos(int tvID,
                                          int seasonNumber,
                                          int episodeNumber,
                                          String language)
                                   throws MovieDbException

Get the videos that have been added to a TV episode (teasers, clips, etc...)

Parameters:

tvID -

seasonNumber -

episodeNumber -

language -

Returns:

Throws:

MovieDbException