com.uwetrottmann.tmdb.services.TvService 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 Java library that provides access to the themoviedatabase API v3.
There is a newer version: 0.10.1
package com.uwetrottmann.tmdb.services;

import com.uwetrottmann.tmdb.entities.AppendToResponse;
import com.uwetrottmann.tmdb.entities.Credits;
import com.uwetrottmann.tmdb.entities.ExternalIds;
import com.uwetrottmann.tmdb.entities.Images;
import com.uwetrottmann.tmdb.entities.TvAlternativeTitles;
import com.uwetrottmann.tmdb.entities.TvKeywords;
import com.uwetrottmann.tmdb.entities.TvResultsPage;
import com.uwetrottmann.tmdb.entities.TvShowComplete;
import com.uwetrottmann.tmdb.entities.Videos;

import retrofit.http.GET;
import retrofit.http.Path;
import retrofit.http.Query;

public interface TvService {
    
    /**
     * Get the primary information about a TV series by id.
     *
     * @param tmdbId A themoviedb id.
     * @param language Optional. ISO 639-1 code.
     * @param appendToResponse Optional. extra requests to append to the result.
     */
    @GET("/tv/{id}")
    TvShowComplete tv(
            @Path("id") int tmdbId,
            @Query("language") String language,
            @Query("append_to_response") AppendToResponse appendToResponse
    );
    
    /**
     * Get the alternative titles for a specific show ID.
     *
     * @param tmdbId A themoviedb id.
     */
    @GET("/tv/{id}/alternative_titles")
    TvAlternativeTitles alternativeTitles(
            @Path("id") int tmdbId
    );

    /**
     * Get the cast and crew information about a TV series. Just like the website, we pull this information from the
     * last season of the series.
     *
     * @param tmdbId A themoviedb id.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/{id}/credits")
    Credits credits(
            @Path("id") int tmdbId,
            @Query("language") String language
    );

    /**
     * Get the external ids that we have stored for a TV series.
     *
     * @param tmdbId A themoviedb id.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/{id}/external_ids")
    ExternalIds externalIds(
            @Path("id") int tmdbId,
            @Query("language") String language
    );
    
    /**
     * Get the images (posters and backdrops) for a TV series.
     *
     * @param tmdbId A themoviedb id.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/{id}/images")
    Images images(
            @Path("id") int tmdbId,
            @Query("language") String language
    );
    
    /**
     * Get the plot keywords for a specific TV show id.
     *
     * @param tmdbId A themoviedb id.
     */
    @GET("/tv/{id}/keywords")
    TvKeywords keywords(
            @Path("id") int tmdbId
    );
    
    /**
     * Get the similar TV shows for a specific tv id.
     *
     * @param tmdbId A themoviedb id.
     * @param page Optional. Minimum value is 1, expected value is an integer.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/{id}/similar")
    TvResultsPage similar(
            @Path("id") int tmdbId,
            @Query("page") Integer page,
            @Query("language") String language
    );
    
    /**
     * Get the videos that have been added to a TV series (trailers, opening credits, etc...)
     *
     * @param tmdbId A themoviedb id.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/{id}/videos")
    Videos videos(
            @Path("id") int tmdbId,
            @Query("language") String language
    );
    
    /**
     * Get the latest TV show id.
     *
     */
    @GET("/tv/latest")
    TvShowComplete latest();
    
    /**
     * 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.
     *
     * @param page Optional. Minimum value is 1, expected value is an integer.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/on_the_air")
    TvResultsPage onTheAir(
            @Query("page") Integer page,
            @Query("language") String language
    );
    
    /**
     * Get the list of TV shows that air today. Without a specified timezone, 
     *this query defaults to EST (Eastern Time UTC-05:00).
     *
     * @param page Optional. Minimum value is 1, expected value is an integer.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/airing_today")
    TvResultsPage airingToday(
            @Query("page") Integer page,
            @Query("language") String language
    );
    
    /**
     * 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.
     *
     * @param page Optional. Minimum value is 1, expected value is an integer.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/top_rated")
    TvResultsPage topRated(
            @Query("page") Integer page,
            @Query("language") String language
    );
    
    /**
     * Get the list of popular TV shows. This list refreshes every day.
     * 
     * @param page Optional. Minimum value is 1, expected value is an integer.
     * @param language Optional. ISO 639-1 code.
     */
    @GET("/tv/popular")
    TvResultsPage popular(
            @Query("page") Integer page,
            @Query("language") String language
    );

}