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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tmdb-java Show documentation

tmdb-java is a retrofit2 based wrapper around the themoviedb.org API v3.

There is a newer version: 2.11.0

package com.uwetrottmann.tmdb2.services;

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

public interface GenresService {

    /**
     * Get the list of movie genres.
     *
     * @param language Optional. ISO 639-1 code.
     */
    @GET("genre/movie/list")
    Call movie(
            @Query("language") String language
    );

    /**
     * Get the list of TV genres.
     *
     * @param language Optional. ISO 639-1 code.
     */
    @GET("genre/tv/list")
    Call tv(
            @Query("language") String language
    );

    /**
     * Get a list of movies by Genre id.
     *
     * Is highly recommend using {@link DiscoverService#discoverMovie(
     *String, String, SortBy, String, String, String, Boolean, Boolean,
     * Integer, Integer, TmdbDate, TmdbDate, TmdbDate, TmdbDate, Integer,
     * Integer, Float, Float, DiscoverFilter, DiscoverFilter, DiscoverFilter,
     * DiscoverFilter, DiscoverFilter, DiscoverFilter, Integer, DiscoverFilter,
     * Integer, Integer, DiscoverFilter, String, DiscoverFilter) discoverMovie}
     * instead of this method as it is much more flexible.
     *
     * @param genreId       A Genre TMDb id.
     * @param language      Optional. ISO 639-1 code.
     * @param include_adult Optional. Toggle the inclusion of adult titles. Expected value is: true or false
     * @param sort_by       Optional. Sort the results. Allowed Values: created_at.asc, created_at.desc
     */
    @GET("genre/{genre_id}/movies")
    Call movies(
            @Path("genre_id") int genreId,
            @Query("language") String language,
            @Query("include_adult") Boolean include_adult,
            @Query("sort_by") SortBy sort_by
    );

}