|
|
|
|
@ -19,24 +19,6 @@
|
|
|
|
|
*/
|
|
|
|
|
package com.omertron.themoviedbapi;
|
|
|
|
|
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.*;
|
|
|
|
|
|
|
|
|
|
import java.io.IOException;
|
|
|
|
|
import java.net.MalformedURLException;
|
|
|
|
|
import java.net.URISyntaxException;
|
|
|
|
|
import java.net.URL;
|
|
|
|
|
import java.util.Collections;
|
|
|
|
|
import java.util.HashMap;
|
|
|
|
|
import java.util.List;
|
|
|
|
|
import java.util.Map;
|
|
|
|
|
|
|
|
|
|
import org.apache.commons.lang3.StringUtils;
|
|
|
|
|
import org.apache.http.client.methods.HttpGet;
|
|
|
|
|
import org.slf4j.Logger;
|
|
|
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
|
import org.yamj.api.common.http.CommonHttpClient;
|
|
|
|
|
import org.yamj.api.common.http.DigestedResponse;
|
|
|
|
|
|
|
|
|
|
import com.fasterxml.jackson.core.JsonProcessingException;
|
|
|
|
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
|
|
|
|
import com.omertron.themoviedbapi.model.Account;
|
|
|
|
|
@ -67,11 +49,23 @@ import com.omertron.themoviedbapi.model.StatusCode;
|
|
|
|
|
import com.omertron.themoviedbapi.model.TmdbConfiguration;
|
|
|
|
|
import com.omertron.themoviedbapi.model.TokenAuthorisation;
|
|
|
|
|
import com.omertron.themoviedbapi.model.TokenSession;
|
|
|
|
|
import com.omertron.themoviedbapi.model.Trailer;
|
|
|
|
|
import com.omertron.themoviedbapi.model.Translation;
|
|
|
|
|
import com.omertron.themoviedbapi.model.Video;
|
|
|
|
|
import com.omertron.themoviedbapi.results.TmdbResultsList;
|
|
|
|
|
import com.omertron.themoviedbapi.results.TmdbResultsMap;
|
|
|
|
|
import com.omertron.themoviedbapi.tools.ApiUrl;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_ADULT;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_COUNTRY;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_END_DATE;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_ID;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_INCLUDE_ALL_MOVIES;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_LANGUAGE;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_PAGE;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_QUERY;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_SESSION;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_START_DATE;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_TOKEN;
|
|
|
|
|
import static com.omertron.themoviedbapi.tools.ApiUrl.PARAM_YEAR;
|
|
|
|
|
import com.omertron.themoviedbapi.tools.WebBrowser;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperAlternativeTitles;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperChanges;
|
|
|
|
|
@ -95,14 +89,32 @@ import com.omertron.themoviedbapi.wrapper.WrapperPersonCredits;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperPersonList;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperReleaseInfo;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperReviews;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperTrailers;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperTranslations;
|
|
|
|
|
import com.omertron.themoviedbapi.wrapper.WrapperVideos;
|
|
|
|
|
import java.io.IOException;
|
|
|
|
|
import java.net.MalformedURLException;
|
|
|
|
|
import java.net.URISyntaxException;
|
|
|
|
|
import java.net.URL;
|
|
|
|
|
import java.nio.charset.Charset;
|
|
|
|
|
import java.util.Collections;
|
|
|
|
|
import java.util.HashMap;
|
|
|
|
|
import java.util.List;
|
|
|
|
|
import java.util.Map;
|
|
|
|
|
import org.apache.commons.lang3.StringUtils;
|
|
|
|
|
import org.apache.http.client.methods.HttpGet;
|
|
|
|
|
import org.apache.http.impl.client.CloseableHttpClient;
|
|
|
|
|
import org.slf4j.Logger;
|
|
|
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
|
import org.yamj.api.common.exception.ApiExceptionType;
|
|
|
|
|
import org.yamj.api.common.http.DigestedResponse;
|
|
|
|
|
import org.yamj.api.common.http.DigestedResponseReader;
|
|
|
|
|
import org.yamj.api.common.http.SimpleHttpClientBuilder;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The MovieDb API
|
|
|
|
|
* <p>
|
|
|
|
|
* This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3
|
|
|
|
|
* This is for version 3 of the API as specified here:
|
|
|
|
|
* http://help.themoviedb.org/kb/api/about-3
|
|
|
|
|
*
|
|
|
|
|
* @author stuart.boston
|
|
|
|
|
*/
|
|
|
|
|
@ -110,8 +122,10 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
private static final Logger LOG = LoggerFactory.getLogger(TheMovieDbApi.class);
|
|
|
|
|
private String apiKey;
|
|
|
|
|
private CommonHttpClient httpClient;
|
|
|
|
|
private CloseableHttpClient httpClient;
|
|
|
|
|
private TmdbConfiguration tmdbConfig;
|
|
|
|
|
private static final String DEFAULT_CHARSET = "UTF-8";
|
|
|
|
|
private final Charset charset = Charset.forName(DEFAULT_CHARSET);
|
|
|
|
|
// API Methods
|
|
|
|
|
private static final String BASE_MOVIE = "movie/";
|
|
|
|
|
private static final String BASE_PERSON = "person/";
|
|
|
|
|
@ -144,7 +158,7 @@ public class TheMovieDbApi {
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
*/
|
|
|
|
|
public TheMovieDbApi(String apiKey) throws MovieDbException {
|
|
|
|
|
this(apiKey, null);
|
|
|
|
|
this(apiKey, new SimpleHttpClientBuilder().build());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
@ -154,7 +168,7 @@ public class TheMovieDbApi {
|
|
|
|
|
* @param httpClient The httpClient to use for web requests.
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
*/
|
|
|
|
|
public TheMovieDbApi(String apiKey, CommonHttpClient httpClient) throws MovieDbException {
|
|
|
|
|
public TheMovieDbApi(String apiKey, CloseableHttpClient httpClient) throws MovieDbException {
|
|
|
|
|
this.apiKey = apiKey;
|
|
|
|
|
this.httpClient = httpClient;
|
|
|
|
|
|
|
|
|
|
@ -208,7 +222,7 @@ public class TheMovieDbApi {
|
|
|
|
|
throw new MovieDbException(ApiExceptionType.UNKNOWN_CAUSE, "Unable to proces delete request", url);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
final DigestedResponse response = httpClient.requestContent(httpGet);
|
|
|
|
|
final DigestedResponse response = DigestedResponseReader.requestContent(httpClient, httpGet, charset);
|
|
|
|
|
|
|
|
|
|
if (response.getStatusCode() >= HTTP_STATUS_500) {
|
|
|
|
|
throw new MovieDbException(ApiExceptionType.HTTP_503_ERROR, response.getContent(), response.getStatusCode(), url, null);
|
|
|
|
|
@ -229,42 +243,6 @@ public class TheMovieDbApi {
|
|
|
|
|
return webpage;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set the proxy information
|
|
|
|
|
*
|
|
|
|
|
* @param host
|
|
|
|
|
* @param port
|
|
|
|
|
* @param username
|
|
|
|
|
* @param password
|
|
|
|
|
*/
|
|
|
|
|
public void setProxy(String host, int port, String username, String password) {
|
|
|
|
|
// should be set in HTTP client already
|
|
|
|
|
if (httpClient != null) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
WebBrowser.setProxyHost(host);
|
|
|
|
|
WebBrowser.setProxyPort(port);
|
|
|
|
|
WebBrowser.setProxyUsername(username);
|
|
|
|
|
WebBrowser.setProxyPassword(password);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set the connection and read time out values
|
|
|
|
|
*
|
|
|
|
|
* @param connect
|
|
|
|
|
* @param read
|
|
|
|
|
*/
|
|
|
|
|
public void setTimeout(int connect, int read) {
|
|
|
|
|
// should be set in HTTP client already
|
|
|
|
|
if (httpClient != null) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
WebBrowser.setWebTimeoutConnect(connect);
|
|
|
|
|
WebBrowser.setWebTimeoutRead(read);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Compare the MovieDB object with a title & year
|
|
|
|
|
*
|
|
|
|
|
@ -283,7 +261,8 @@ public class TheMovieDbApi {
|
|
|
|
|
* @param moviedb The moviedb object to compare too
|
|
|
|
|
* @param title The title of the movie to compare
|
|
|
|
|
* @param year The year of the movie to compare
|
|
|
|
|
* @param maxDistance The Levenshtein Distance between the two titles. 0 = exact match
|
|
|
|
|
* @param maxDistance The Levenshtein Distance between the two titles. 0 =
|
|
|
|
|
* exact match
|
|
|
|
|
* @param caseSensitive true if the comparison is to be case sensitive
|
|
|
|
|
* @return True if there is a match, False otherwise.
|
|
|
|
|
*/
|
|
|
|
|
@ -399,13 +378,16 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Authentication Functions">
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to generate a valid request token for user based authentication.
|
|
|
|
|
* 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.
|
|
|
|
|
* 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.
|
|
|
|
|
* As soon as a valid session id has been created the token will be
|
|
|
|
|
* destroyed.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
@ -425,7 +407,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to generate a session id for user based authentication.
|
|
|
|
|
* 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.
|
|
|
|
|
*
|
|
|
|
|
@ -456,14 +439,18 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
* 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.
|
|
|
|
|
* 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.
|
|
|
|
|
* 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.
|
|
|
|
|
* If a guest session is not used for the first time within 24 hours, it
|
|
|
|
|
* will be automatically discarded.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
@ -483,7 +470,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the basic information for an account. You will need to have a valid session id.
|
|
|
|
|
* Get the basic information for an account. You will need to have a valid
|
|
|
|
|
* session id.
|
|
|
|
|
*
|
|
|
|
|
* @param sessionId
|
|
|
|
|
* @return
|
|
|
|
|
@ -595,7 +583,8 @@ public class TheMovieDbApi {
|
|
|
|
|
*
|
|
|
|
|
* It will return the single highest rated poster and backdrop.
|
|
|
|
|
*
|
|
|
|
|
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
|
|
|
|
|
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies
|
|
|
|
|
* found.
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -634,7 +623,8 @@ public class TheMovieDbApi {
|
|
|
|
|
*
|
|
|
|
|
* It will return the single highest rated poster and backdrop.
|
|
|
|
|
*
|
|
|
|
|
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
|
|
|
|
|
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies
|
|
|
|
|
* found.
|
|
|
|
|
*
|
|
|
|
|
* @param imdbId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -669,7 +659,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the alternative titles we have for a particular movie.
|
|
|
|
|
* This method is used to retrieve all of the alternative titles we have for
|
|
|
|
|
* a particular movie.
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param country
|
|
|
|
|
@ -731,7 +722,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method should be used when you’re wanting to retrieve all of the images for a particular movie.
|
|
|
|
|
* This method should be used when you’re wanting to retrieve all of the
|
|
|
|
|
* images for a particular movie.
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -764,7 +756,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the keywords that have been added to a particular movie.
|
|
|
|
|
* This method is used to retrieve all of the keywords that have been added
|
|
|
|
|
* to a particular movie.
|
|
|
|
|
*
|
|
|
|
|
* Currently, only English keywords exist.
|
|
|
|
|
*
|
|
|
|
|
@ -794,7 +787,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the release and certification data we have for a specific movie.
|
|
|
|
|
* This method is used to retrieve all of the release and certification data
|
|
|
|
|
* we have for a specific movie.
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -824,7 +818,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the trailers for a particular movie.
|
|
|
|
|
* This method is used to retrieve all of the trailers for a particular
|
|
|
|
|
* movie.
|
|
|
|
|
*
|
|
|
|
|
* Supported sites are YouTube and QuickTime.
|
|
|
|
|
*
|
|
|
|
|
@ -834,7 +829,7 @@ public class TheMovieDbApi {
|
|
|
|
|
* @return
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
*/
|
|
|
|
|
public TmdbResultsList<Trailer> getMovieTrailers(int movieId, String language, String... appendToResponse) throws MovieDbException {
|
|
|
|
|
public TmdbResultsList<Video> getMovieTrailers(int movieId, String language, String... appendToResponse) throws MovieDbException {
|
|
|
|
|
ApiUrl apiUrl = new ApiUrl(apiKey, BASE_MOVIE, "/videos");
|
|
|
|
|
apiUrl.addArgument(PARAM_ID, movieId);
|
|
|
|
|
|
|
|
|
|
@ -848,8 +843,8 @@ public class TheMovieDbApi {
|
|
|
|
|
String webpage = requestWebPage(url);
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
WrapperTrailers wrapper = mapper.readValue(webpage, WrapperTrailers.class);
|
|
|
|
|
TmdbResultsList<Trailer> results = new TmdbResultsList<Trailer>(wrapper.getTrailers());
|
|
|
|
|
WrapperVideos wrapper = mapper.readValue(webpage, WrapperVideos.class);
|
|
|
|
|
TmdbResultsList<Video> results = new TmdbResultsList<Video>(wrapper.getTrailers());
|
|
|
|
|
results.copyWrapper(wrapper);
|
|
|
|
|
return results;
|
|
|
|
|
} catch (IOException ex) {
|
|
|
|
|
@ -859,7 +854,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve a list of the available translations for a specific movie.
|
|
|
|
|
* This method is used to retrieve a list of the available translations for
|
|
|
|
|
* a specific movie.
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param appendToResponse
|
|
|
|
|
@ -887,9 +883,11 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The similar movies method will let you retrieve the similar movies for a particular movie.
|
|
|
|
|
* 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.
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
@ -1001,11 +999,13 @@ public class TheMovieDbApi {
|
|
|
|
|
*
|
|
|
|
|
* 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 maximum number of days that can be returned in a single request is
|
|
|
|
|
* 14.
|
|
|
|
|
*
|
|
|
|
|
* The language is present on fields that are translatable.
|
|
|
|
|
*
|
|
|
|
|
* TODO: DOES NOT WORK AT THE MOMENT. This is due to the "value" item changing type in the ChangeItem
|
|
|
|
|
* TODO: DOES NOT WORK AT THE MOMENT. This is due to the "value" item
|
|
|
|
|
* changing type in the ChangeItem
|
|
|
|
|
*
|
|
|
|
|
* @param movieId
|
|
|
|
|
* @param startDate the start date of the changes, optional
|
|
|
|
|
@ -1103,7 +1103,8 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
* This is a curated list that will normally contain 100 movies. The default
|
|
|
|
|
* response will return 20 movies.
|
|
|
|
|
*
|
|
|
|
|
* TODO: Implement more than 20 movies
|
|
|
|
|
*
|
|
|
|
|
@ -1175,7 +1176,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
|
|
|
|
|
* This method is used to retrieve the top rated movies that have over 10
|
|
|
|
|
* votes on TMDb.
|
|
|
|
|
*
|
|
|
|
|
* The default response will return 20 movies.
|
|
|
|
|
*
|
|
|
|
|
@ -1273,9 +1275,11 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Collection Functions">
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the basic information about a movie collection.
|
|
|
|
|
* 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.
|
|
|
|
|
* You can get the ID needed for this method by making a getMovieInfo
|
|
|
|
|
* request for the belongs_to_collection.
|
|
|
|
|
*
|
|
|
|
|
* @param collectionId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -1361,7 +1365,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve all of the cast & crew information for the person.
|
|
|
|
|
* This method is used to retrieve all of the cast & crew information for
|
|
|
|
|
* the person.
|
|
|
|
|
*
|
|
|
|
|
* It will return the single highest rated poster for each movie record.
|
|
|
|
|
*
|
|
|
|
|
@ -1423,7 +1428,8 @@ public class TheMovieDbApi {
|
|
|
|
|
*
|
|
|
|
|
* 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 maximum number of days that can be returned in a single request is
|
|
|
|
|
* 14.
|
|
|
|
|
*
|
|
|
|
|
* The language is present on fields that are translatable.
|
|
|
|
|
*
|
|
|
|
|
@ -1501,7 +1507,8 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Company Functions">
|
|
|
|
|
/**
|
|
|
|
|
* This method is used to retrieve the basic information about a production company on TMDb.
|
|
|
|
|
* This method is used to retrieve the basic information about a production
|
|
|
|
|
* company on TMDb.
|
|
|
|
|
*
|
|
|
|
|
* @param companyId
|
|
|
|
|
* @return
|
|
|
|
|
@ -1526,7 +1533,8 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
* These movies are returned in order of most recently released to oldest.
|
|
|
|
|
* The default response will return 20 movies per page.
|
|
|
|
|
*
|
|
|
|
|
* TODO: Implement more than 20 movies
|
|
|
|
|
*
|
|
|
|
|
@ -1595,9 +1603,11 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* Get a list of movies per genre.
|
|
|
|
|
*
|
|
|
|
|
* It is important to understand that only movies with more than 10 votes get listed.
|
|
|
|
|
* 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.
|
|
|
|
|
* This prevents movies from 1 10/10 rating from being listed first and for
|
|
|
|
|
* the first 5 pages.
|
|
|
|
|
*
|
|
|
|
|
* @param genreId
|
|
|
|
|
* @param language
|
|
|
|
|
@ -1637,13 +1647,16 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Search Functions">
|
|
|
|
|
/**
|
|
|
|
|
* Search Movies This is a good starting point to start finding movies on TMDb.
|
|
|
|
|
* Search Movies This is a good starting point to start finding movies on
|
|
|
|
|
* TMDb.
|
|
|
|
|
*
|
|
|
|
|
* @param movieName
|
|
|
|
|
* @param searchYear Limit the search to the provided year. Zero (0) will get all years
|
|
|
|
|
* @param searchYear Limit the search to the provided year. Zero (0) will
|
|
|
|
|
* get all years
|
|
|
|
|
* @param language The language to include. Can be blank/null.
|
|
|
|
|
* @param includeAdult true or false to include adult titles in the search
|
|
|
|
|
* @param page The page of results to return. 0 to get the default (first page)
|
|
|
|
|
* @param page The page of results to return. 0 to get the default (first
|
|
|
|
|
* page)
|
|
|
|
|
* @return
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
*/
|
|
|
|
|
@ -1723,7 +1736,8 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
* The idea is to be a quick and light method so you can iterate through
|
|
|
|
|
* people quickly.
|
|
|
|
|
*
|
|
|
|
|
* @param personName
|
|
|
|
|
* @param includeAdult
|
|
|
|
|
@ -1795,8 +1809,8 @@ public class TheMovieDbApi {
|
|
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
@ -1960,7 +1974,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method lets users add new movies to a list that they created. A valid session id is required.
|
|
|
|
|
* This method lets users add new movies to a list that they created. A
|
|
|
|
|
* valid session id is required.
|
|
|
|
|
*
|
|
|
|
|
* @param sessionId
|
|
|
|
|
* @param listId
|
|
|
|
|
@ -1973,7 +1988,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method lets users remove movies from a list that they created. A valid session id is required.
|
|
|
|
|
* This method lets users remove movies from a list that they created. A
|
|
|
|
|
* valid session id is required.
|
|
|
|
|
*
|
|
|
|
|
* @param sessionId
|
|
|
|
|
* @param listId
|
|
|
|
|
@ -2027,7 +2043,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method lets users delete a list that they created. A valid session id is required.
|
|
|
|
|
* This method lets users delete a list that they created. A valid session
|
|
|
|
|
* id is required.
|
|
|
|
|
*
|
|
|
|
|
* @param sessionId
|
|
|
|
|
* @param listId
|
|
|
|
|
@ -2114,10 +2131,12 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Changes Functions">
|
|
|
|
|
/**
|
|
|
|
|
* Get a list of movie ids that have been edited. By default we show the last 24 hours and only 100 items per page. The maximum
|
|
|
|
|
* number of days that can be returned in a single request is 14. You can then use the movie changes API to get the actual data
|
|
|
|
|
* that has been changed. Please note that the change log system to support this was changed on October 5, 2012 and will only
|
|
|
|
|
* show movies that have been edited since.
|
|
|
|
|
* Get a list of movie ids that have been edited. By default we show the
|
|
|
|
|
* last 24 hours and only 100 items per page. The maximum number of days
|
|
|
|
|
* that can be returned in a single request is 14. You can then use the
|
|
|
|
|
* movie changes API to get the actual data that has been changed. Please
|
|
|
|
|
* note that the change log system to support this was changed on October 5,
|
|
|
|
|
* 2012 and will only show movies that have been edited since.
|
|
|
|
|
*
|
|
|
|
|
* @param page
|
|
|
|
|
* @param startDate the start date of the changes, optional
|
|
|
|
|
@ -2181,30 +2200,42 @@ public class TheMovieDbApi {
|
|
|
|
|
|
|
|
|
|
//<editor-fold defaultstate="collapsed" desc="Discover">
|
|
|
|
|
/**
|
|
|
|
|
* Discover movies by different types of data like average rating, number of votes, genres and certifications.
|
|
|
|
|
* Discover movies by different types of data like average rating, number of
|
|
|
|
|
* votes, genres and certifications.
|
|
|
|
|
*
|
|
|
|
|
* You can alternatively create a "discover" object and pass it to this method to cut out the requirement for all of these
|
|
|
|
|
* parameters
|
|
|
|
|
* You can alternatively create a "discover" object and pass it to this
|
|
|
|
|
* method to cut out the requirement for all of these parameters
|
|
|
|
|
*
|
|
|
|
|
* @param page Minimum value is 1
|
|
|
|
|
* @param language ISO 639-1 code.
|
|
|
|
|
* @param sortBy Available options are vote_average.desc, vote_average.asc, release_date.desc, release_date.asc,
|
|
|
|
|
* popularity.desc, popularity.asc
|
|
|
|
|
* @param sortBy Available options are vote_average.desc, vote_average.asc,
|
|
|
|
|
* release_date.desc, release_date.asc, popularity.desc, popularity.asc
|
|
|
|
|
* @param includeAdult Toggle the inclusion of adult titles
|
|
|
|
|
* @param year Filter the results release dates to matches that include this value
|
|
|
|
|
* @param primaryReleaseYear Filter the results so that only the primary release date year has this value
|
|
|
|
|
* @param voteCountGte Only include movies that are equal to, or have a vote count higher than this value
|
|
|
|
|
* @param voteAverageGte Only include movies that are equal to, or have a higher average rating than this value
|
|
|
|
|
* @param withGenres Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple
|
|
|
|
|
* values can be specified. Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
|
|
|
|
|
* @param releaseDateGte The minimum release to include. Expected format is YYYY-MM-DD
|
|
|
|
|
* @param releaseDateLte The maximum release to include. Expected format is YYYY-MM-DD
|
|
|
|
|
* @param certificationCountry Only include movies with certifications for a specific country. When this value is specified,
|
|
|
|
|
* 'certificationLte' is required. A ISO 3166-1 is expected.
|
|
|
|
|
* @param certificationLte Only include movies with this certification and lower. Expected value is a valid certification for
|
|
|
|
|
* the specified 'certificationCountry'.
|
|
|
|
|
* @param withCompanies Filter movies to include a specific company. Expected value is an integer (the id of a company). They
|
|
|
|
|
* can be comma separated to indicate an 'AND' query.
|
|
|
|
|
* @param year Filter the results release dates to matches that include this
|
|
|
|
|
* value
|
|
|
|
|
* @param primaryReleaseYear Filter the results so that only the primary
|
|
|
|
|
* release date year has this value
|
|
|
|
|
* @param voteCountGte Only include movies that are equal to, or have a vote
|
|
|
|
|
* count higher than this value
|
|
|
|
|
* @param voteAverageGte Only include movies that are equal to, or have a
|
|
|
|
|
* higher average rating than this value
|
|
|
|
|
* @param withGenres Only include movies with the specified genres. Expected
|
|
|
|
|
* value is an integer (the id of a genre). Multiple values can be
|
|
|
|
|
* specified. Comma separated indicates an 'AND' query, while a pipe (|)
|
|
|
|
|
* separated value indicates an 'OR'.
|
|
|
|
|
* @param releaseDateGte The minimum release to include. Expected format is
|
|
|
|
|
* YYYY-MM-DD
|
|
|
|
|
* @param releaseDateLte The maximum release to include. Expected format is
|
|
|
|
|
* YYYY-MM-DD
|
|
|
|
|
* @param certificationCountry Only include movies with certifications for a
|
|
|
|
|
* specific country. When this value is specified, 'certificationLte' is
|
|
|
|
|
* required. A ISO 3166-1 is expected.
|
|
|
|
|
* @param certificationLte Only include movies with this certification and
|
|
|
|
|
* lower. Expected value is a valid certification for the specified
|
|
|
|
|
* 'certificationCountry'.
|
|
|
|
|
* @param withCompanies Filter movies to include a specific company.
|
|
|
|
|
* Expected value is an integer (the id of a company). They can be comma
|
|
|
|
|
* separated to indicate an 'AND' query.
|
|
|
|
|
* @return
|
|
|
|
|
* @throws MovieDbException
|
|
|
|
|
*/
|
|
|
|
|
@ -2232,7 +2263,8 @@ public class TheMovieDbApi {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Discover movies by different types of data like average rating, number of votes, genres and certifications.
|
|
|
|
|
* Discover movies by different types of data like average rating, number of
|
|
|
|
|
* votes, genres and certifications.
|
|
|
|
|
*
|
|
|
|
|
* @param discover A discover object containing the search criteria required
|
|
|
|
|
* @return
|
|
|
|
|
|