-
Notifications
You must be signed in to change notification settings - Fork 19
/
IMovieDbService.java
73 lines (65 loc) · 2.37 KB
/
IMovieDbService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
* Copyright (C) 2018, Brian He
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.brianspace.moviebrowser.repository;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import com.github.brianspace.moviebrowser.repository.data.Configuration;
import com.github.brianspace.moviebrowser.repository.data.MovieData;
import com.github.brianspace.moviebrowser.repository.data.MovieDetailsData;
import com.github.brianspace.moviebrowser.repository.data.PagingEnvelope;
import io.reactivex.Single;
/**
* Interface for accessing TMDb Web API.
*/
public interface IMovieDbService {
/**
* Clear the HTTP cache.
* @return true for success and false for failure.
*/
boolean clearCache();
/**
* Get configuration (image base URL, image size, etc.).
*
* @return RxJava {@code Single} for the configuration.
*/
@NonNull
Single<Configuration> getConfiguration();
/**
* Get the list of now playing movies.
*
* @param previous the previous page of movie data list.
* @return RxJava {@code Single} for the page of movie list.
*/
@NonNull
Single<PagingEnvelope<MovieData>> getMovieNowPlaying(@Nullable PagingEnvelope<MovieData> previous);
/**
* Get extra details for a movie.
*
* @param id the ID of the movie to request for details.
* @return RxJava {@code Single} for the details data.
*/
@NonNull
Single<MovieDetailsData> getMovieDetails(int id);
/**
* Get the list of similar movies.
*
* @param id the ID of the movie to request for similar movies.
* @param previous the previous page of movie data list.
* @return RxJava {@code Single} for the page of movie list.
*/
@NonNull
Single<PagingEnvelope<MovieData>> getSimilarMovies(int id, @Nullable PagingEnvelope<MovieData> previous);
}