com.uwetrottmann.tmdb2.services.CollectionsService 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.AppendToResponse;
import com.uwetrottmann.tmdb2.entities.Collection;
import com.uwetrottmann.tmdb2.entities.Images;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;

import java.util.Map;

public interface CollectionsService {

    /**
     * Get the basic collection information for a specific collection id.
     *
     * @param collectionId TMDb id.
     * @param language     Optional. ISO 639-1 code.
     */
    @GET("collection/{collection_id}")
    Call summary(
            @Path("collection_id") int collectionId,
            @Query("language") String language
    );

    /**
     * Get the basic collection information for a specific collection id.
     *
     * @param collectionId     TMDb id.
     * @param language         Optional. ISO 639-1 code.
     * @param appendToResponse Optional. extra requests to append to the result.
     */
    @GET("collection/{collection_id}")
    Call summary(
            @Path("collection_id") int collectionId,
            @Query("language") String language,
            @Query("append_to_response") AppendToResponse appendToResponse
    );

    /**
     * Get the basic collection information for a specific collection id.
     *
     * @param collectionId     TMDb id.
     * @param language         Optional. ISO 639-1 code.
     * @param appendToResponse Optional. extra requests to append to the result.
     * @param options          Optional. parameters for the appended extra results.
     */
    @GET("collection/{collection_id}")
    Call summary(
            @Path("collection_id") int collectionId,
            @Query("language") String language,
            @Query("append_to_response") AppendToResponse appendToResponse,
            @QueryMap Map options
    );

    /**
     * Get the images (posters and backdrops) for a specific collection id.
     *
     * @param collectionId TMDb id.
     * @param language     Optional. ISO 639-1 code.
     */
    @GET("collection/{collection_id}/images")
    Call images(
            @Path("collection_id") int collectionId,
            @Query("language") String language
    );
}