• Home
• com.uwetrottmann.tmdb2
• tmdb-java
• 2.4.0
• source code
• DiscoverService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.uwetrottmann.tmdb2.services.DiscoverService Maven / Gradle / Ivy

package com.uwetrottmann.tmdb2.services;

import com.uwetrottmann.tmdb2.entities.DiscoverFilter;
import com.uwetrottmann.tmdb2.entities.MovieResultsPage;
import com.uwetrottmann.tmdb2.entities.TmdbDate;
import com.uwetrottmann.tmdb2.entities.TvShowResultsPage;
import com.uwetrottmann.tmdb2.enumerations.SortBy;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;

public interface DiscoverService {

    /**
     * 
Discover movies by different types of data like average rating, number of votes, genres and certifications.

     * You can get a valid list of certifications from the /certifications method.
     * 
Discover also supports a nice list of sort options. See below for all of the available options.
     * 
Please note, when using certification \ certification.lte you must also specify certification_country.

     * These two parameters work together in order to filter the results. You can only filter results with the countries we have added to our certifications list.
     * 
If you specify the region parameter, the regional release date will be used instead of the primary release date.

     * The date returned will be the first date based on your query (ie. if a with_release_type is specified).

     * It's important to note the order of the release types that are used.

     * Specifying "2|3" would return the limited theatrical release date as opposed to "3|2" which would return the theatrical date.
     *
     * @param language                 Optional. ISO 639-1 code.
     * @param region                   Optional. ISO 3166-1 code.
     * @param sort_by                  Optional. Allowed Values: , popularity.asc, popularity.desc, release_date.asc, release_date.desc, revenue.asc, revenue.desc, primary_release_date.asc, primary_release_date.desc, original_title.asc, original_title.desc, vote_average.asc, vote_average.desc, vote_count.asc, vote_count.desc
     *                                 Default: popularity.desc
     * @param certification_country    Optional. Used in conjunction with the certification filter, use this to specify a country with a valid certification.
     * @param certification            Optional. Filter results with a valid certification from the 'certification_country' field.
     * @param certification_lte        Optional. Filter and only include movies that have a certification that is less than or equal to the specified value.
     * @param include_adult            Optional. A filter and include or exclude adult movies. Expected values: true/false.
     * @param include_video            Optional. A filter to include or exclude videos. Expected Values: true/false.
     * @param page                     Optional. Minimum value is 1, expected value is an integer.
     * @param primary_release_year     Optional. A filter to limit the results to a specific primary release year.
     * @param primary_release_date_gte Optional. Filter and only include movies that have a primary release date that is greater or equal to the specified value.
     * @param primary_release_date_lte Optional. Filter and only include movies that have a primary release date that is less than or equal to the specified value.
     * @param release_date_gte         Optional. Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value.
     * @param release_date_lte         Optional. Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value.
     * @param vote_count_gte           Optional. Filter and only include movies that have a vote count that is greater or equal to the specified value.
     * @param vote_count_lte           Optional. Filter and only include movies that have a vote count that is less than or equal to the specified value.
     * @param vote_average_gte         Optional. Filter and only include movies that have a rating that is greater or equal to the specified value.
     * @param vote_average_lte         Optional. Filter and only include movies that have a rating that is less than or equal to the specified value.
     * @param with_cast                Optional. Only include movies that have one of the ID's added as an actor.
     * @param with_crew                Optional. Only include movies that have one of the ID's added as a crew member.
     * @param with_companies           Optional. Only include movies that have one of the ID's added as a production company.
     * @param with_genres              Optional. Only include movies that have one of the ID's added as a genre.
     * @param with_keywords            Optional. Only include movies that have one of the ID's added as a keyword.
     * @param with_people              Optional. Only include movies that have one of the ID's added as a either a actor or a crew member.
     * @param year                     Optional. A filter to limit the results to a specific year (looking at all release dates).
     * @param without_genres           Optional. Genre ids that you want to exclude from the results.
     * @param with_runtime_gte         Optional. Filter and only include movies that have a runtime that is greater or equal to a value.
     * @param with_runtime_lte         Optional. Filter and only include movies that have a runtime that is less than or equal to a value.
     * @param with_release_type        Optional. These release types map to the same values found on the movie release date method.
     * @param with_original_language   Optional. ISO 639-1 string to filter results by their original language value.
     * @param without_keywords         Optional. Exclude items with certain keywords.
     * @see Movie Discover
     */
    @GET("discover/movie")
    Call discoverMovie(
            @Query("language") String language,
            @Query("region") String region,
            @Query("sort_by") SortBy sort_by,
            @Query("certification_country") String certification_country,
            @Query("certification") String certification,
            @Query("certification_lte") String certification_lte,
            @Query("include_adult") Boolean include_adult,
            @Query("include_video") Boolean include_video,
            @Query("page") Integer page,
            @Query("primary_release_year") Integer primary_release_year,
            @Query("primary_release_date.gte") TmdbDate primary_release_date_gte,
            @Query("primary_release_date.lte") TmdbDate primary_release_date_lte,
            @Query("release_date.gte") TmdbDate release_date_gte,
            @Query("release_date.lte") TmdbDate release_date_lte,
            @Query("vote_count.gte") Integer vote_count_gte,
            @Query("vote_count.lte") Integer vote_count_lte,
            @Query("vote_average.gte") Float vote_average_gte,
            @Query("vote_average.lte") Float vote_average_lte,
            @Query("with_cast") DiscoverFilter with_cast,
            @Query("with_crew") DiscoverFilter with_crew,
            @Query("with_companies") DiscoverFilter with_companies,
            @Query("with_genres") DiscoverFilter with_genres,
            @Query("with_keywords") DiscoverFilter with_keywords,
            @Query("with_people") DiscoverFilter with_people,
            @Query("year") Integer year,
            @Query("without_genres") DiscoverFilter without_genres,
            @Query("with_runtime.gte") Integer with_runtime_gte,
            @Query("with_runtime.lte") Integer with_runtime_lte,
            @Query("with_release_type") DiscoverFilter with_release_type,
            @Query("with_original_language") String with_original_language,
            @Query("without_keywords") DiscoverFilter without_keywords
    );

    /**
     * Discover TV shows by different types of data like average rating, number of votes, genres, the network they aired
     * on and air dates.
     *
     * @param language                     Optional. ISO 639-1 code.
     * @param sort_by                      Optional. Allowed Values: , popularity.asc, popularity.desc, release_date.asc, release_date.desc, revenue.asc, revenue.desc, primary_release_date.asc, primary_release_date.desc, original_title.asc, original_title.desc, vote_average.asc, vote_average.desc, vote_count.asc, vote_count.desc
     *                                     Default: popularity.desc
     * @param air_date_gte                 Optional. Filter and only include TV shows that have a air date (by looking at all episodes) that is greater or equal to the specified value.
     * @param air_date_lte                 Optional. Filter and only include TV shows that have a air date (by looking at all episodes) that is less than or equal to the specified value.
     * @param first_air_date_gte           Optional. Filter and only include TV shows that have a original air date that is greater or equal to the specified value. Can be used in conjunction with the "include_null_first_air_dates" filter if you want to include items with no air date.
     * @param first_air_date_lte           Optional. Filter and only include TV shows that have a original air date that is less than or equal to the specified value. Can be used in conjunction with the "include_null_first_air_dates" filter if you want to include items with no air date.
     * @param first_air_date_year          Optional. Filter and only include TV shows that have a original air date year that equal to the specified value. Can be used in conjunction with the "include_null_first_air_dates" filter if you want to include items with no air date.
     * @param page                         Optional. Minimum value is 1, expected value is an integer.
     * @param timezone                     Optional. Used in conjunction with the air_date.gte/lte filter to calculate the proper UTC offset.
     * @param vote_average_gte             Optional. Filter and only include movies that have a rating that is greater or equal to the specified value.
     * @param vote_count_gte               Optional. Filter and only include movies that have a rating that is less than or equal to the specified value.
     * @param with_genres                  Optional. Genre ids that you want to include in the results.
     * @param with_networks                Optional. Network ids that you want to include in the results.
     * @param without_genres               Optional. Genre ids that you want to exclude from the results.
     * @param with_runtime_gte             Optional. Filter and only include movies that have a runtime that is greater or equal to a value.
     * @param with_runtime_lte             Optional. Filter and only include movies that have a runtime that is less than or equal to a value.
     * @param include_null_first_air_dates Optional. Use this filter to include TV shows that don't have an air date while using any of the "first_air_date" filters.
     * @param with_original_language       Optional. ISO 639-1 string to filter results by their original language value.
     * @param without_keywords             Optional. Exclude items with certain keywords.
     * @see TV Discover
     */
    @GET("discover/tv")
    Call discoverTv(
            @Query("language") String language,
            @Query("sort_by") SortBy sort_by,
            @Query("air_date.gte") TmdbDate air_date_gte,
            @Query("air_date.lte") TmdbDate air_date_lte,
            @Query("first_air_date.gte") TmdbDate first_air_date_gte,
            @Query("first_air_date.lte") TmdbDate first_air_date_lte,
            @Query("first_air_date_year") Integer first_air_date_year,
            @Query("page") Integer page,
            @Query("timezone") String timezone,
            @Query("vote_average.gte") Float vote_average_gte,
            @Query("vote_count.gte") Integer vote_count_gte,
            @Query("with_genres") DiscoverFilter with_genres,
            @Query("with_networks") DiscoverFilter with_networks,
            @Query("without_genres") DiscoverFilter without_genres,
            @Query("with_runtime.gte") Integer with_runtime_gte,
            @Query("with_runtime.lte") Integer with_runtime_lte,
            @Query("include_null_first_air_dates") Boolean include_null_first_air_dates,
            @Query("with_original_language") String with_original_language,
            @Query("without_keywords") DiscoverFilter without_keywords
    );

}