TheMovieDbApi (API-The MovieDB 4.3 API)

java.lang.Object
- com.omertron.themoviedbapi.TheMovieDbApi

```
public class TheMovieDbApi
extends Object
```
The MovieInfo API
This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3

Author:

stuart.boston

Constructor Summary

Constructors
Constructor and Description
`TheMovieDbApi(String apiKey)` API for The Movie Db.
`TheMovieDbApi(String apiKey, org.apache.http.client.HttpClient httpClient)` API for The Movie Db.

Method Summary

Methods
Modifier and Type	Method and Description
`StatusCode`	`addItemToList(String sessionId, String listId, Integer mediaId)` This method lets users add new items to a list that they created.
`StatusCode`	`addToWatchList(String sessionId, int accountId, MediaType mediaType, Integer mediaId)` Add a movie to an accounts watch list.
`boolean`	`checkItemStatus(String listId, Integer mediaId)` Check to see if an item is already on a list.
`URL`	`createImageUrl(String imagePath, String requiredSize)` Generate the full image URL from the size and image path
`String`	`createList(String sessionId, String name, String description)` This method lets users create a new list.
`StatusCode`	`deleteList(String sessionId, String listId)` This method lets users delete a list that they created.
`FindResults`	`find(String id, ExternalSource externalSource, String language)` You con use this method to find movies, tv series or persons using external ids.
`Account`	`getAccount(String sessionId)` Get the basic information for an account.
`TokenAuthorisation`	`getAuthorisationToken()` This method is used to generate a valid request token for user based authentication.
`ResultList<Artwork>`	`getCollectionImages(int collectionId, String language)` Get all of the images for a particular collection by collection id.
`CollectionInfo`	`getCollectionInfo(int collectionId, String language)` This method is used to retrieve all of the basic information about a movie collection.
`Company`	`getCompanyInfo(int companyId)` This method is used to retrieve the basic information about a production company on TMDb.
`ResultList<MovieBasic>`	`getCompanyMovies(int companyId, String language, Integer page)` This method is used to retrieve the movies associated with a company.
`Configuration`	`getConfiguration()` Get the configuration information
`CreditInfo`	`getCreditInfo(String creditId, String language)` Get the detailed information about a particular credit record.
`ResultList<MovieBasic>`	`getDiscoverMovies(Discover discover)` Discover movies by different types of data like average rating, number of votes, genres and certifications.
`ResultList<TVBasic>`	`getDiscoverTV(Discover discover)` Discover movies by different types of data like average rating, number of votes, genres and certifications.
`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...)
`ResultList<MovieBasic>`	`getFavoriteMovies(String sessionId, int accountId)` Get the account favourite movies
`ResultList<TVBasic>`	`getFavoriteTv(String sessionId, int accountId)` Get the list of favorite TV series for an account.
`ResultList<Genre>`	`getGenreMovieList(String language)` Get the list of Movie genres.
`ResultList<MovieBasic>`	`getGenreMovies(int genreId, String language, Integer page, Boolean includeAllMovies, Boolean includeAdult)` Get a list of movies per genre.
`ResultList<Genre>`	`getGenreTVList(String language)` Get the list of TV genres..
`ResultList<MovieBasic>`	`getGuestRatedMovies(String guestSessionId, String language, Integer page, SortBy sortBy)` Get a list of rated movies for a specific guest session id.
`TokenSession`	`getGuestSessionToken()` This method is used to generate a guest session id.
`ResultList<JobDepartment>`	`getJobs()` Get a list of valid jobs
`Keyword`	`getKeyword(String keywordId)` Get the basic information for a specific keyword id.
`ResultList<MovieBasic>`	`getKeywordMovies(String keywordId, String language, Integer page)` Get the list of movies for a particular keyword by id.
`MovieInfo`	`getLatestMovie()` This method is used to retrieve the newest movie that was added to TMDb.
`TVInfo`	`getLatestTV()` Get the latest TV show id.
`ListItem<MovieInfo>`	`getList(String listId)` Get a list by its ID
`MediaState`	`getMovieAccountState(int movieId, String sessionId)` This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch list.
`ResultList<AlternativeTitle>`	`getMovieAlternativeTitles(int movieId, String country)` This method is used to retrieve all of the alternative titles we have for a particular movie.
`ResultList<ChangeListItem>`	`getMovieChangeList(Integer page, String startDate, String endDate)` Get a list of Movie IDs that have been edited.
`ResultList<ChangeKeyItem>`	`getMovieChanges(int movieId, String startDate, String endDate)` Get the changes for a specific movie ID.
`MediaCreditList`	`getMovieCredits(int movieId)` Get the cast and crew information for a specific movie id.
`ResultList<Artwork>`	`getMovieImages(int movieId, String language)` This method should be used when you’re wanting to retrieve all of the images for a particular movie.
`MovieInfo`	`getMovieInfo(int movieId, String language, String... appendToResponse)` This method is used to retrieve all of the basic movie information.
`MovieInfo`	`getMovieInfoImdb(String imdbId, String language, String... appendToResponse)` This method is used to retrieve all of the basic movie information.
`ResultList<Keyword>`	`getMovieKeywords(int movieId)` This method is used to retrieve all of the keywords that have been added to a particular movie.
`ResultList<UserList>`	`getMovieLists(int movieId, Integer page, String language)` Get the lists that the movie belongs to
`ResultList<ReleaseInfo>`	`getMovieReleaseInfo(int movieId, String language)` This method is used to retrieve all of the release and certification data we have for a specific movie.
`ResultList<Review>`	`getMovieReviews(int movieId, Integer page, String language)` Get the reviews for a particular movie id.
`ResultsMap<String,List<Certification>>`	`getMoviesCertification()` Get a list of movies certification.
`ResultList<Translation>`	`getMovieTranslations(int movieId)` This method is used to retrieve a list of the available translations for a specific movie.
`ResultList<Video>`	`getMovieVideos(int movieId, String language)` This method is used to retrieve all of the trailers for a particular movie.
`Network`	`getNetworkInfo(int networkId)` This method is used to retrieve the basic information about a TV network.
`ResultList<MovieInfo>`	`getNowPlayingMovies(Integer page, String language)` This method is used to retrieve the movies currently in theatres.
`ResultList<ChangeListItem>`	`getPersonChangeList(Integer page, String startDate, String endDate)` Get a list of PersonInfo IDs that have been edited.
`ResultList<ChangeKeyItem>`	`getPersonChanges(int personId, String startDate, String endDate)` Get the changes for a specific person id.
`PersonCreditList<CreditBasic>`	`getPersonCombinedCredits(int personId, String language)` Get the combined (movie and TV) credits for a specific person id.
`ExternalID`	`getPersonExternalIds(int personId)` Get the external ids for a specific person id.
`ResultList<Artwork>`	`getPersonImages(int personId)` Get the images for a specific person id.
`PersonInfo`	`getPersonInfo(int personId, String... appendToResponse)` Get the general person information for a specific id.
`PersonInfo`	`getPersonLatest()` Get the latest person id.
`PersonCreditList<CreditMovieBasic>`	`getPersonMovieCredits(int personId, String language)` Get the movie credits for a specific person id.
`ResultList<PersonFind>`	`getPersonPopular(Integer page)` Get the list of popular people on The Movie Database.
`ResultList<ArtworkMedia>`	`getPersonTaggedImages(int personId, Integer page, String language)` Get the images that have been tagged with a specific person id.
`PersonCreditList<CreditTVBasic>`	`getPersonTVCredits(int personId, String language)` Get the TV credits for a specific person id.
`ResultList<MovieInfo>`	`getPopularMovieList(Integer page, String language)` This method is used to retrieve the daily movie popularity list.
`ResultList<MovieBasic>`	`getRatedMovies(String sessionId, int accountId, Integer page, String sortBy, String language)` Get the list of rated movies (and associated rating) for an account.
`ResultList<TVBasic>`	`getRatedTV(String sessionId, int accountId, Integer page, String sortBy, String language)` Get the list of rated TV shows (and associated rating) for an account.
`Review`	`getReviews(String reviewId)`
`MediaState`	`getSeasonAccountState(int tvID, String sessionID)` This method lets users get the status of whether or not the TV episodes of a season have been rated.
`ResultList<ChangeKeyItem>`	`getSeasonChanges(int tvID, String startDate, String endDate)` Look up a TV season's changes by season ID.
`MediaCreditList`	`getSeasonCredits(int tvID, int seasonNumber)` Get the cast & crew credits for a TV season by season number.
`ExternalID`	`getSeasonExternalID(int tvID, int seasonNumber, String language)` Get the external ids that we have stored for a TV season by season number.
`ResultList<Artwork>`	`getSeasonImages(int tvID, int seasonNumber, String language, String... includeImageLanguage)` Get the images that we have stored for a TV season by season number.
`TVSeasonInfo`	`getSeasonInfo(int tvID, int seasonNumber, String language, String... appendToResponse)` Get the primary information about a TV season by its season number.
`ResultList<Video>`	`getSeasonVideos(int tvID, int seasonNumber, String language)` Get the videos that have been added to a TV season (trailers, teasers, etc...)
`TokenSession`	`getSessionToken(TokenAuthorisation token)` This method is used to generate a session id for user based authentication.
`TokenAuthorisation`	`getSessionTokenLogin(TokenAuthorisation token, String username, String password)` This method is used to generate a session id for user based authentication.
`ResultList<MovieInfo>`	`getSimilarMovies(int movieId, Integer page, String language)` The similar movies method will let you retrieve the similar movies for a particular movie.
`ResultsMap<String,List<String>>`	`getTimezones()` Get the list of supported timezones for the API methods that support them.
`ResultList<MovieInfo>`	`getTopRatedMovies(Integer page, String language)` This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
`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.
`ResultsMap<String,List<Certification>>`	`getTvCertification()` Get a list of tv certification.
`ResultList<ChangeListItem>`	`getTvChangeList(Integer page, String startDate, String endDate)` Get a list of TV IDs that have been edited.
`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...)
`ResultList<MovieInfo>`	`getUpcoming(Integer page, String language)` Get the list of upcoming movies.
`ResultList<UserList>`	`getUserLists(String sessionId, int accountId)` Get all lists of a given user
`ResultList<MovieBasic>`	`getWatchListMovie(String sessionId, int accountId, Integer page, String sortBy, String language)` Get the list of movies on an accounts watchlist.
`ResultList<TVBasic>`	`getWatchListTV(String sessionId, int accountId, Integer page, String sortBy, String language)` Get the list of movies on an accounts watchlist.
`StatusCode`	`modifyFavoriteStatus(String sessionId, int accountId, Integer mediaId, MediaType mediaType, boolean isFavorite)` Add or remove a movie to an accounts favourite list.
`StatusCode`	`postEpisodeRating(int tvID, int seasonNumber, int episodeNumber, int rating, String sessionID, String guestSessionID)` This method lets users rate a TV episode.
`StatusCode`	`postMovieRating(int movieId, int rating, String sessionId, String guestSessionId)` This method lets users rate a movie.
`StatusCode`	`postTVRating(int tvID, int rating, String sessionID, String guestSessionID)` This method lets users rate a TV show.
`StatusCode`	`removeFromWatchList(String sessionId, int accountId, MediaType mediaType, Integer mediaId)` Remove a movie from an accounts watch list.
`StatusCode`	`removeItemFromList(String sessionId, String listId, Integer mediaId)` This method lets users remove items from a list that they created.
`ResultList<Collection>`	`searchCollection(String query, Integer page, String language)` Search for collections by name.
`ResultList<Company>`	`searchCompanies(String query, Integer page)` Search Companies.
`ResultList<Keyword>`	`searchKeyword(String query, Integer page)` Search for keywords by name
`ResultList<UserList>`	`searchList(String query, Integer page, Boolean includeAdult)` Search for lists by name and description.
`ResultList<MovieInfo>`	`searchMovie(String query, Integer page, String language, Boolean includeAdult, Integer searchYear, Integer primaryReleaseYear, SearchType searchType)` Search Movies This is a good starting point to start finding movies on TMDb.
`ResultList<MediaBasic>`	`searchMulti(String query, Integer page, String language, Boolean includeAdult)` Search the movie, tv show and person collections with a single query.
`ResultList<PersonFind>`	`searchPeople(String query, Integer page, Boolean includeAdult, SearchType searchType)` This is a good starting point to start finding people on TMDb.
`ResultList<TVBasic>`	`searchTV(String query, Integer page, String language, Integer firstAirDateYear, SearchType searchType)` Search for TV shows by title.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TheMovieDbApi
```
public TheMovieDbApi(String apiKey)
              throws MovieDbException
```
  API for The Movie Db.
  
  Parameters:
  apiKey -
  
  Throws:
  
  MovieDbException
- TheMovieDbApi
```
public TheMovieDbApi(String apiKey,
             org.apache.http.client.HttpClient httpClient)
              throws MovieDbException
```
  API for The Movie Db.
  
  Parameters:
  apiKey -
  httpClient - The httpClient to use for web requests.
  
  Throws:
  
  MovieDbException

Method Detail

getAccount
```
public Account getAccount(String sessionId)
                   throws MovieDbException
```
Get the basic information for an account. You will need to have a valid session id.

Parameters:
sessionId -

Returns:

Throws:

MovieDbException

getUserLists

public ResultList<UserList> getUserLists(String sessionId,
                                int accountId)
                                  throws MovieDbException

Get all lists of a given user

Parameters:: sessionId -; accountId -
Returns:: The lists
Throws:: MovieDbException

getFavoriteMovies

public ResultList<MovieBasic> getFavoriteMovies(String sessionId,
                                       int accountId)
                                         throws MovieDbException

Get the account favourite movies

Parameters:: sessionId -; accountId -
Returns:
Throws:: MovieDbException

modifyFavoriteStatus

public StatusCode modifyFavoriteStatus(String sessionId,
                              int accountId,
                              Integer mediaId,
                              MediaType mediaType,
                              boolean isFavorite)
                                throws MovieDbException

Add or remove a movie to an accounts favourite list.

Parameters:: sessionId -; accountId -; mediaId -; mediaType -; isFavorite -
Returns:
Throws:: MovieDbException

getRatedMovies

public ResultList<MovieBasic> getRatedMovies(String sessionId,
                                    int accountId,
                                    Integer page,
                                    String sortBy,
                                    String language)
                                      throws MovieDbException

Get the list of rated movies (and associated rating) for an account.

Parameters:: sessionId -; accountId -; page -; sortBy -; language -
Returns:
Throws:: MovieDbException

getRatedTV

public ResultList<TVBasic> getRatedTV(String sessionId,
                             int accountId,
                             Integer page,
                             String sortBy,
                             String language)
                               throws MovieDbException

Get the list of rated TV shows (and associated rating) for an account.

Parameters:: sessionId -; accountId -; page -; sortBy -; language -
Returns:
Throws:: MovieDbException

getWatchListMovie

public ResultList<MovieBasic> getWatchListMovie(String sessionId,
                                       int accountId,
                                       Integer page,
                                       String sortBy,
                                       String language)
                                         throws MovieDbException

Get the list of movies on an accounts watchlist.

Parameters:: sessionId -; accountId -; page -; sortBy -; language -
Returns:: The watchlist of the user
Throws:: MovieDbException

getWatchListTV

public ResultList<TVBasic> getWatchListTV(String sessionId,
                                 int accountId,
                                 Integer page,
                                 String sortBy,
                                 String language)
                                   throws MovieDbException

Get the list of movies on an accounts watchlist.

Parameters:: sessionId -; accountId -; page -; sortBy -; language -
Returns:: The watchlist of the user
Throws:: MovieDbException

addToWatchList

public StatusCode addToWatchList(String sessionId,
                        int accountId,
                        MediaType mediaType,
                        Integer mediaId)
                          throws MovieDbException

Add a movie to an accounts watch list.

Parameters:: sessionId -; accountId -; mediaId -; mediaType -
Returns:
Throws:: MovieDbException

removeFromWatchList

public StatusCode removeFromWatchList(String sessionId,
                             int accountId,
                             MediaType mediaType,
                             Integer mediaId)
                               throws MovieDbException

Remove a movie from an accounts watch list.

Parameters:: sessionId -; accountId -; mediaId -; mediaType -
Returns:
Throws:: MovieDbException

getFavoriteTv

public ResultList<TVBasic> getFavoriteTv(String sessionId,
                                int accountId)
                                  throws MovieDbException

Get the list of favorite TV series for an account.

Parameters:: sessionId -; accountId -
Returns:
Throws:: MovieDbException

getGuestRatedMovies

public ResultList<MovieBasic> getGuestRatedMovies(String guestSessionId,
                                         String language,
                                         Integer page,
                                         SortBy sortBy)
                                           throws MovieDbException

Get a list of rated movies for a specific guest session id.

Parameters:: guestSessionId -; language -; page -; sortBy - only CREATED_AT_ASC or CREATED_AT_DESC is supported
Returns:
Throws:: MovieDbException

getAuthorisationToken
```
public TokenAuthorisation getAuthorisationToken()
                                         throws MovieDbException
```
This method is used to generate a valid request token for user based authentication. A request token is required in order to request a session id. You can generate any number of request tokens but they will expire after 60 minutes. As soon as a valid session id has been created the token will be destroyed.

Returns:

Throws:

MovieDbException

getSessionToken
```
public TokenSession getSessionToken(TokenAuthorisation token)
                             throws MovieDbException
```
This method is used to generate a session id for user based authentication. A session id is required in order to use any of the write methods.

Parameters:
token -

Returns:

Throws:

MovieDbException

getSessionTokenLogin

public TokenAuthorisation getSessionTokenLogin(TokenAuthorisation token,
                                      String username,
                                      String password)
                                        throws MovieDbException

This method is used to generate a session id for user based authentication. User must provide their username and password A session id is required in order to use any of the write methods.

Parameters:: token - Session token; username - User's username; password - User's password
Returns:
Throws:: MovieDbException

getGuestSessionToken
```
public TokenSession getGuestSessionToken()
                                  throws MovieDbException
```
This method is used to generate a guest session id. A guest session can be used to rate movies without having a registered TMDb user account. You should only generate a single guest session per user (or device) as you will be able to attach the ratings to a TMDb user account in the future. There are also IP limits in place so you should always make sure it's the end user doing the guest session actions. If a guest session is not used for the first time within 24 hours, it will be automatically discarded.

Returns:

Throws:

MovieDbException

getMoviesCertification

public ResultsMap<String,List<Certification>> getMoviesCertification()
                                                              throws MovieDbException

Get a list of movies certification.

Returns:
Throws:: MovieDbException

getTvCertification

public ResultsMap<String,List<Certification>> getTvCertification()
                                                          throws MovieDbException

Get a list of tv certification.

Returns:
Throws:: MovieDbException

getMovieChangeList

public ResultList<ChangeListItem> getMovieChangeList(Integer page,
                                            String startDate,
                                            String endDate)
                                              throws MovieDbException

Get a list of Movie IDs that have been edited. You can then use the movie changes API to get the actual data that has been changed.

Parameters:: page -; startDate - the start date of the changes, optional; endDate - the end date of the changes, optional
Returns:: List of changed movie
Throws:: MovieDbException

getTvChangeList

public ResultList<ChangeListItem> getTvChangeList(Integer page,
                                         String startDate,
                                         String endDate)
                                           throws MovieDbException

Get a list of TV IDs that have been edited. You can then use the TV changes API to get the actual data that has been changed.

Parameters:: page -; startDate - the start date of the changes, optional; endDate - the end date of the changes, optional
Returns:: List of changed movie
Throws:: MovieDbException

getPersonChangeList

public ResultList<ChangeListItem> getPersonChangeList(Integer page,
                                             String startDate,
                                             String endDate)
                                               throws MovieDbException

Get a list of PersonInfo IDs that have been edited. You can then use the person changes API to get the actual data that has been changed.

Parameters:: page -; startDate - the start date of the changes, optional; endDate - the end date of the changes, optional
Returns:: List of changed movie
Throws:: MovieDbException

getCollectionInfo
```
public CollectionInfo getCollectionInfo(int collectionId,
                               String language)
                                 throws MovieDbException
```
This method is used to retrieve all of the basic information about a movie collection. You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection.

Parameters:
collectionId -
language -

Returns:

Throws:

MovieDbException

getCollectionImages

public ResultList<Artwork> getCollectionImages(int collectionId,
                                      String language)
                                        throws MovieDbException

Get all of the images for a particular collection by collection id.

Parameters:: collectionId -; language -
Returns:
Throws:: MovieDbException

getCompanyInfo
```
public Company getCompanyInfo(int companyId)
                       throws MovieDbException
```
This method is used to retrieve the basic information about a production company on TMDb.

Parameters:
companyId -

Returns:

Throws:

MovieDbException

getCompanyMovies

public ResultList<MovieBasic> getCompanyMovies(int companyId,
                                      String language,
                                      Integer page)
                                        throws MovieDbException

This method is used to retrieve the movies associated with a company. These movies are returned in order of most recently released to oldest. The default response will return 20 movies per page.

Parameters:: companyId -; language -; page -
Returns:
Throws:: MovieDbException

getConfiguration

public Configuration getConfiguration()
                               throws MovieDbException

Get the configuration information

Returns:
Throws:: MovieDbException

createImageUrl

public URL createImageUrl(String imagePath,
                 String requiredSize)
                   throws MovieDbException

Generate the full image URL from the size and image path

Parameters:: imagePath -; requiredSize -
Returns:
Throws:: MovieDbException

getJobs

public ResultList<JobDepartment> getJobs()
                                  throws MovieDbException

Get a list of valid jobs

Returns:
Throws:: MovieDbException

getTimezones
```
public ResultsMap<String,List<String>> getTimezones()
                                             throws MovieDbException
```
Get the list of supported timezones for the API methods that support them.

Returns:
@throws MovieDbException

Throws:

MovieDbException

getCreditInfo
```
public CreditInfo getCreditInfo(String creditId,
                       String language)
                         throws MovieDbException
```
Get the detailed information about a particular credit record.
This is currently only supported with the new credit model found in TV.
These IDs can be found from any TV credit response as well as the TV_credits and combined_credits methods for people.
The episodes object returns a list of episodes and are generally going to be guest stars.
The season array will return a list of season numbers.
Season credits are credits that were marked with the "add to every season" option in the editing interface and are assumed to be "season regulars".

Parameters:
creditId -
language -

Returns:

Throws:

MovieDbException

getDiscoverMovies
```
public ResultList<MovieBasic> getDiscoverMovies(Discover discover)
                                         throws MovieDbException
```
Discover movies by different types of data like average rating, number of votes, genres and certifications.

Parameters:
discover - A discover object containing the search criteria required

Returns:

Throws:

MovieDbException

getDiscoverTV
```
public ResultList<TVBasic> getDiscoverTV(Discover discover)
                                  throws MovieDbException
```
Discover movies by different types of data like average rating, number of votes, genres and certifications.

Parameters:
discover - A discover object containing the search criteria required

Returns:

Throws:

MovieDbException

find
```
public FindResults find(String id,
               ExternalSource externalSource,
               String language)
                 throws MovieDbException
```
You con use this method to find movies, tv series or persons using external ids. Supported query ids are
- Movies: imdb_id
- People: imdb_id, freebase_mid, freebase_id, tvrage_id
- TV Series: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
- TV Seasons: freebase_mid, freebase_id, tvdb_id, tvrage_id
- TV Episodes: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_idimdb_id, freebase_mid, freebase_id, tvrage_id, tvdb_id.
For details see http://docs.themoviedb.apiary.io/#find
Parameters:
id - the external id
externalSource - one of ExternalSource.
language - the language

Returns:

Throws:

MovieDbException

getGenreMovieList

public ResultList<Genre> getGenreMovieList(String language)
                                    throws MovieDbException

Get the list of Movie genres.

Parameters:: language -
Returns:
Throws:: MovieDbException

getGenreTVList

public ResultList<Genre> getGenreTVList(String language)
                                 throws MovieDbException

Get the list of TV genres..

Parameters:: language -
Returns:
Throws:: MovieDbException

getGenreMovies

public ResultList<MovieBasic> getGenreMovies(int genreId,
                                    String language,
                                    Integer page,
                                    Boolean includeAllMovies,
                                    Boolean includeAdult)
                                      throws MovieDbException

Get a list of movies per genre. It is important to understand that only movies with more than 10 votes get listed. This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages.

Parameters:: genreId -; language -; page -; includeAllMovies -; includeAdult -
Returns:
Throws:: MovieDbException

getKeyword
```
public Keyword getKeyword(String keywordId)
                   throws MovieDbException
```
Get the basic information for a specific keyword id.

Parameters:
keywordId -

Returns:

Throws:

MovieDbException

getKeywordMovies

public ResultList<MovieBasic> getKeywordMovies(String keywordId,
                                      String language,
                                      Integer page)
                                        throws MovieDbException

Get the list of movies for a particular keyword by id.

Parameters:: keywordId -; language -; page -
Returns:: List of movies with the keyword
Throws:: MovieDbException

getList

public ListItem<MovieInfo> getList(String listId)
                            throws MovieDbException

Get a list by its ID

Parameters:: listId -
Returns:: The list and its items
Throws:: MovieDbException

createList

public String createList(String sessionId,
                String name,
                String description)
                  throws MovieDbException

This method lets users create a new list. A valid session id is required.

Parameters:: sessionId -; name -; description -
Returns:: The list id
Throws:: MovieDbException

deleteList

public StatusCode deleteList(String sessionId,
                    String listId)
                      throws MovieDbException

This method lets users delete a list that they created. A valid session id is required.

Parameters:: sessionId -; listId -
Returns:
Throws:: MovieDbException

checkItemStatus

public boolean checkItemStatus(String listId,
                      Integer mediaId)
                        throws MovieDbException

Check to see if an item is already on a list.

Parameters:: listId -; mediaId -
Returns:: true if the item is on the list
Throws:: MovieDbException

addItemToList

public StatusCode addItemToList(String sessionId,
                       String listId,
                       Integer mediaId)
                         throws MovieDbException

This method lets users add new items to a list that they created. A valid session id is required.

Parameters:: sessionId -; listId -; mediaId -
Returns:: true if the movie is on the list
Throws:: MovieDbException

removeItemFromList

public StatusCode removeItemFromList(String sessionId,
                            String listId,
                            Integer mediaId)
                              throws MovieDbException

This method lets users remove items from a list that they created. A valid session id is required.

Parameters:: sessionId -; listId -; mediaId -
Returns:: true if the movie is on the list
Throws:: MovieDbException

getMovieInfo
```
public MovieInfo getMovieInfo(int movieId,
                     String language,
                     String... appendToResponse)
                       throws MovieDbException
```
This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.

Parameters:
movieId -
language -
appendToResponse -

Returns:

Throws:

MovieDbException

getMovieInfoImdb
```
public MovieInfo getMovieInfoImdb(String imdbId,
                         String language,
                         String... appendToResponse)
                           throws MovieDbException
```
This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.

Parameters:
imdbId -
language -
appendToResponse -

Returns:

Throws:

MovieDbException

getMovieAccountState
```
public MediaState getMovieAccountState(int movieId,
                              String sessionId)
                                throws MovieDbException
```
This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch list. A valid session id is required.

Parameters:
movieId -
sessionId -

Returns:

Throws:

MovieDbException

getMovieAlternativeTitles

public ResultList<AlternativeTitle> getMovieAlternativeTitles(int movieId,
                                                     String country)
                                                       throws MovieDbException

This method is used to retrieve all of the alternative titles we have for a particular movie.

Parameters:: movieId -; country -
Returns:
Throws:: MovieDbException

getMovieCredits
```
public MediaCreditList getMovieCredits(int movieId)
                                throws MovieDbException
```
Get the cast and crew information for a specific movie id.

Parameters:
movieId -

Returns:

Throws:

MovieDbException

getMovieImages

public ResultList<Artwork> getMovieImages(int movieId,
                                 String language)
                                   throws MovieDbException

This method should be used when you’re wanting to retrieve all of the images for a particular movie.

Parameters:: movieId -; language -
Returns:
Throws:: MovieDbException

getMovieKeywords
```
public ResultList<Keyword> getMovieKeywords(int movieId)
                                     throws MovieDbException
```
This method is used to retrieve all of the keywords that have been added to a particular movie. Currently, only English keywords exist.

Parameters:
movieId -

Returns:

Throws:

MovieDbException

getMovieReleaseInfo

public ResultList<ReleaseInfo> getMovieReleaseInfo(int movieId,
                                          String language)
                                            throws MovieDbException

This method is used to retrieve all of the release and certification data we have for a specific movie.

Parameters:: movieId -; language -
Returns:
Throws:: MovieDbException

getMovieVideos

public ResultList<Video> getMovieVideos(int movieId,
                               String language)
                                 throws MovieDbException

This method is used to retrieve all of the trailers for a particular movie. Supported sites are YouTube and QuickTime.

Parameters:: movieId -; language -
Returns:
Throws:: MovieDbException

getMovieTranslations
```
public ResultList<Translation> getMovieTranslations(int movieId)
                                             throws MovieDbException
```
This method is used to retrieve a list of the available translations for a specific movie.

Parameters:
movieId -

Returns:

Throws:

MovieDbException

getSimilarMovies

public ResultList<MovieInfo> getSimilarMovies(int movieId,
                                     Integer page,
                                     String language)
                                       throws MovieDbException

The similar movies method will let you retrieve the similar movies for a particular movie. This data is created dynamically but with the help of users votes on TMDb. The data is much better with movies that have more keywords

Parameters:: movieId -; language -; page -
Returns:
Throws:: MovieDbException

getMovieReviews

public ResultList<Review> getMovieReviews(int movieId,
                                 Integer page,
                                 String language)
                                   throws MovieDbException

Get the reviews for a particular movie id.

Parameters:: movieId -; page -; language -
Returns:
Throws:: MovieDbException

getMovieLists

public ResultList<UserList> getMovieLists(int movieId,
                                 Integer page,
                                 String language)
                                   throws MovieDbException

Get the lists that the movie belongs to

Parameters:: movieId -; language -; page -
Returns:
Throws:: MovieDbException

getMovieChanges
```
public ResultList<ChangeKeyItem> getMovieChanges(int movieId,
                                        String startDate,
                                        String endDate)
                                          throws MovieDbException
```
Get the changes for a specific movie ID. Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.

Parameters:
movieId -
startDate -
endDate -

Returns:

Throws:

MovieDbException

postMovieRating

public StatusCode postMovieRating(int movieId,
                         int rating,
                         String sessionId,
                         String guestSessionId)
                           throws MovieDbException

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

Parameters:: sessionId -; movieId -; rating -; guestSessionId -
Returns:
Throws:: MovieDbException

getLatestMovie
```
public MovieInfo getLatestMovie()
                         throws MovieDbException
```
This method is used to retrieve the newest movie that was added to TMDb.

Returns:

Throws:

MovieDbException

getUpcoming

public ResultList<MovieInfo> getUpcoming(Integer page,
                                String language)
                                  throws MovieDbException

Get the list of upcoming movies. This list refreshes every day. The maximum number of items this list will include is 100.

Parameters:: language -; page -
Returns:
Throws:: MovieDbException

getNowPlayingMovies
```
public ResultList<MovieInfo> getNowPlayingMovies(Integer page,
                                        String language)
                                          throws MovieDbException
```
This method is used to retrieve the movies currently in theatres. This is a curated list that will normally contain 100 movies. The default response will return 20 movies.

Parameters:
language -
page -

Returns:

Throws:

MovieDbException

getPopularMovieList

public ResultList<MovieInfo> getPopularMovieList(Integer page,
                                        String language)
                                          throws MovieDbException

This method is used to retrieve the daily movie popularity list. This list is updated daily. The default response will return 20 movies.

Parameters:: language -; page -
Returns:
Throws:: MovieDbException

getTopRatedMovies

public ResultList<MovieInfo> getTopRatedMovies(Integer page,
                                      String language)
                                        throws MovieDbException

This method is used to retrieve the top rated movies that have over 10 votes on TMDb. The default response will return 20 movies.

Parameters:: language -; page -
Returns:
Throws:: MovieDbException

getNetworkInfo
```
public Network getNetworkInfo(int networkId)
                       throws MovieDbException
```
This method is used to retrieve the basic information about a TV network.
You can use this ID to search for TV shows with the discover method.

Parameters:
networkId -

Returns:

Throws:

MovieDbException

getPersonInfo

public PersonInfo getPersonInfo(int personId,
                       String... appendToResponse)
                         throws MovieDbException

Get the general person information for a specific id.

Parameters:: personId -; appendToResponse -
Returns:
Throws:: MovieDbException

getPersonMovieCredits

public PersonCreditList<CreditMovieBasic> getPersonMovieCredits(int personId,
                                                       String language)
                                                         throws MovieDbException

Get the movie credits for a specific person id.

Parameters:: personId -; language -
Returns:
Throws:: MovieDbException

getPersonTVCredits
```
public PersonCreditList<CreditTVBasic> getPersonTVCredits(int personId,
                                                 String language)
                                                   throws MovieDbException
```
Get the TV credits for a specific person id. To get the expanded details for each record, call the /credit method with the provided credit_id. This will provide details about which episode and/or season the credit is for.

Parameters:
personId -
language -

Returns:

Throws:

MovieDbException

getPersonCombinedCredits
```
public PersonCreditList<CreditBasic> getPersonCombinedCredits(int personId,
                                                     String language)
                                                       throws MovieDbException
```
Get the combined (movie and TV) credits for a specific person id. To get the expanded details for each TV record, call the /credit method with the provided credit_id. This will provide details about which episode and/or season the credit is for.

Parameters:
personId -
language -

Returns:

Throws:

MovieDbException

getPersonExternalIds
```
public ExternalID getPersonExternalIds(int personId)
                                throws MovieDbException
```
Get the external ids for a specific person id.

Parameters:
personId -

Returns:

Throws:

MovieDbException

getPersonImages

public ResultList<Artwork> getPersonImages(int personId)
                                    throws MovieDbException

Get the images for a specific person id.

Parameters:: personId -
Returns:
Throws:: MovieDbException

getPersonTaggedImages

public ResultList<ArtworkMedia> getPersonTaggedImages(int personId,
                                             Integer page,
                                             String language)
                                               throws MovieDbException

Get the images that have been tagged with a specific person id. We return all of the image results with a media object mapped for each image.

Parameters:: personId -; page -; language -
Returns:
Throws:: MovieDbException

getPersonChanges
```
public ResultList<ChangeKeyItem> getPersonChanges(int personId,
                                         String startDate,
                                         String endDate)
                                           throws MovieDbException
```
Get the changes for a specific person id. Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.

Parameters:
personId -
startDate -
endDate -

Returns:

Throws:

MovieDbException

getPersonPopular
```
public ResultList<PersonFind> getPersonPopular(Integer page)
                                        throws MovieDbException
```
Get the list of popular people on The Movie Database. This list refreshes every day.

Parameters:
page -

Returns:

Throws:

MovieDbException

getPersonLatest

public PersonInfo getPersonLatest()
                           throws MovieDbException

Get the latest person id.

Returns:
Throws:: MovieDbException

getReviews

public Review getReviews(String reviewId)
                  throws MovieDbException

Parameters:: reviewId -
Returns:: @throws MovieDbException
Throws:: MovieDbException

searchCompanies
```
public ResultList<Company> searchCompanies(String query,
                                  Integer page)
                                    throws MovieDbException
```
Search Companies. You can use this method to search for production companies that are part of TMDb. The company IDs will map to those returned on movie calls. http://help.themoviedb.org/kb/api/search-companies

Parameters:
query -
page -

Returns:

Throws:

MovieDbException

searchCollection

public ResultList<Collection> searchCollection(String query,
                                      Integer page,
                                      String language)
                                        throws MovieDbException

Search for collections by name.

Parameters:: query -; language -; page -
Returns:
Throws:: MovieDbException

searchKeyword

public ResultList<Keyword> searchKeyword(String query,
                                Integer page)
                                  throws MovieDbException

Search for keywords by name

Parameters:: query -; page -
Returns:
Throws:: MovieDbException

searchList

public ResultList<UserList> searchList(String query,
                              Integer page,
                              Boolean includeAdult)
                                throws MovieDbException

Search for lists by name and description.

Parameters:: query -; includeAdult -; page -
Returns:
Throws:: MovieDbException

searchMovie

public ResultList<MovieInfo> searchMovie(String query,
                                Integer page,
                                String language,
                                Boolean includeAdult,
                                Integer searchYear,
                                Integer primaryReleaseYear,
                                SearchType searchType)
                                  throws MovieDbException

Search Movies This is a good starting point to start finding movies on TMDb.

Parameters:: query -; searchYear - Limit the search to the provided year. Zero (0) will get all years; language - The language to include. Can be blank/null.; includeAdult - true or false to include adult titles in the search; page - The page of results to return. 0 to get the default (first page); primaryReleaseYear -; searchType -
Returns:
Throws:: MovieDbException

searchMulti

public ResultList<MediaBasic> searchMulti(String query,
                                 Integer page,
                                 String language,
                                 Boolean includeAdult)
                                   throws MovieDbException

Search the movie, tv show and person collections with a single query. Each item returned in the result array has a media_type field that maps to either movie, tv or person. Each mapped result is the same response you would get from each independent search

Parameters:: query -; page -; language -; includeAdult -
Returns:
Throws:: MovieDbException

searchPeople

public ResultList<PersonFind> searchPeople(String query,
                                  Integer page,
                                  Boolean includeAdult,
                                  SearchType searchType)
                                    throws MovieDbException

This is a good starting point to start finding people on TMDb. The idea is to be a quick and light method so you can iterate through people quickly.

Parameters:: query -; includeAdult -; page -; searchType -
Returns:
Throws:: MovieDbException

searchTV

public ResultList<TVBasic> searchTV(String query,
                           Integer page,
                           String language,
                           Integer firstAirDateYear,
                           SearchType searchType)
                             throws MovieDbException

Search for TV shows by title.

Parameters:: query -; page -; language -; firstAirDateYear -; searchType -
Returns:
Throws:: MovieDbException

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

getSeasonInfo

public TVSeasonInfo getSeasonInfo(int tvID,
                         int seasonNumber,
                         String language,
                         String... appendToResponse)
                           throws MovieDbException

Get the primary information about a TV season by its season number.

Parameters:: tvID -; seasonNumber -; language -; appendToResponse -
Returns:
Throws:: MovieDbException

getSeasonChanges

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

Look up a TV season's changes by season ID.

Parameters:: tvID -; startDate -; endDate -
Returns:
Throws:: MovieDbException

getSeasonAccountState
```
public MediaState getSeasonAccountState(int tvID,
                               String sessionID)
                                 throws MovieDbException
```
This method lets users get the status of whether or not the TV episodes of a season have been rated. A valid session id is required.

Parameters:
tvID -
sessionID -

Returns:

Throws:

MovieDbException

getSeasonCredits

public MediaCreditList getSeasonCredits(int tvID,
                               int seasonNumber)
                                 throws MovieDbException

Get the cast & crew credits for a TV season by season number.

Parameters:: tvID -; seasonNumber -
Returns:
Throws:: MovieDbException

getSeasonExternalID

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

Get the external ids that we have stored for a TV season by season number.

Parameters:: tvID -; seasonNumber -; language -
Returns:
Throws:: MovieDbException

getSeasonImages

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

Get the images that we have stored for a TV season by season number.

Parameters:: tvID -; seasonNumber -; language -; includeImageLanguage -
Returns:
Throws:: MovieDbException

getSeasonVideos

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

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

Parameters:: tvID -; seasonNumber -; language -
Returns:
Throws:: MovieDbException

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

Class TheMovieDbApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TheMovieDbApi

TheMovieDbApi

Method Detail

getAccount

getUserLists

getFavoriteMovies

modifyFavoriteStatus

getRatedMovies

getRatedTV

getWatchListMovie

getWatchListTV

addToWatchList

removeFromWatchList

getFavoriteTv

getGuestRatedMovies

getAuthorisationToken

getSessionToken

getSessionTokenLogin

getGuestSessionToken

getMoviesCertification

getTvCertification

getMovieChangeList

getTvChangeList

getPersonChangeList

getCollectionInfo

getCollectionImages

getCompanyInfo

getCompanyMovies

getConfiguration

createImageUrl

getJobs

getTimezones

getCreditInfo

getDiscoverMovies

getDiscoverTV

find

getGenreMovieList

getGenreTVList

getGenreMovies

getKeyword

getKeywordMovies

getList

createList

deleteList

checkItemStatus

addItemToList

removeItemFromList

getMovieInfo

getMovieInfoImdb

getMovieAccountState

getMovieAlternativeTitles

getMovieCredits

getMovieImages

getMovieKeywords

getMovieReleaseInfo

getMovieVideos

getMovieTranslations

getSimilarMovies

getMovieReviews

getMovieLists

getMovieChanges

postMovieRating

getLatestMovie

getUpcoming

getNowPlayingMovies

getPopularMovieList

getTopRatedMovies

getNetworkInfo

getPersonInfo

getPersonMovieCredits

getPersonTVCredits

getPersonCombinedCredits

getPersonExternalIds

getPersonImages

getPersonTaggedImages