Package com.amilesend.tmdb.client.api

Class AccountApi

java.lang.Object

com.amilesend.tmdb.client.api.ApiBase

com.amilesend.tmdb.client.api.AccountApi

public class AccountApi
extends ApiBase

Defines APIs to access user account information. Note: A valid session must be authenticated and obtained. This can be done via the SessionManager.

See Also:

• SessionManager

Constructor Summary

Constructors

Constructor	Description
AccountApi(com.amilesend.client.connection.Connection connection)	Creates a new AccountApi object.

Method Summary

Modifier and Type	Method	Description
AddFavoriteResponse	addFavorite(@NonNull AddFavoriteRequest request)	Adds or removes a movie/TV show from an account's favorite list.
AddWatchlistResponse	addWatchlist(@NonNull AddWatchlistRequest request)	Adds or removes a movie/TV show from an account's watch list.
GetAccountDetailsResponse	getAccountDetails(@NonNull GetAccountDetailsRequest request)	Gets the account information.
GetAccountDetailsResponse	getAccountDetailsForSession(@NonNull GetAccountDetailsForSessionRequest request)	Gets the account information associated with a session.
GetFavoriteMoviesResponse	getFavoriteMovies(@NonNull GetFavoriteMoviesRequest request)	Gets the list of favorite movies for an account.
GetFavoriteTvShowsResponse	getFavoriteTvShows(@NonNull GetFavoriteTvShowsRequest request)	Gets the list of favorite TV shows for an account.
GetListsResponse	getLists(@NonNull GetListsRequest request)	Gets the list of a user's configured lists.
GetRatedMoviesResponse	getRatedMovies(@NonNull GetRatedMoviesRequest request)	Gets the list of movies that a user rated.
GetRatedTvEpisodesResponse	getRatedTvEpisodes(@NonNull GetRatedTvEpisodesRequest request)	Gets the list of TV show episodes that a user rated.
GetRatedTvShowsResponse	getRatedTvShows(@NonNull GetRatedTvShowsRequest request)	Gets the list of TV shows that a user rated.
GetWatchlistMoviesResponse	getWatchlistMovies(@NonNull GetWatchlistMoviesRequest request)	Gets the list of movies on a user's watchlist.
GetWatchlistTvResponse	getWatchlistTvShows(@NonNull GetWatchlistTvRequest request)	Gets the list of TV shows on a user's watchlist.

Methods inherited from class com.amilesend.tmdb.client.api.ApiBase

getConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AccountApi

public AccountApi(com.amilesend.client.connection.Connection connection)

Creates a new AccountApi object.

Parameters:

connection - the underlying client connection

Method Details

getAccountDetails

public GetAccountDetailsResponse getAccountDetails(@NonNull GetAccountDetailsRequest request)

Gets the account information.

Parameters:

request - the request

Returns:

the account details

See Also:

• GetAccountDetailsRequest
• GetAccountDetailsResponse

getAccountDetailsForSession

public GetAccountDetailsResponse getAccountDetailsForSession(@NonNull GetAccountDetailsForSessionRequest request)

Gets the account information associated with a session.

Parameters:

request - the request

Returns:

the response

See Also:

• GetAccountDetailsForSessionRequest
• GetAccountDetailsResponse

addFavorite

public AddFavoriteResponse addFavorite(@NonNull AddFavoriteRequest request)

Adds or removes a movie/TV show from an account's favorite list.

Parameters:

request - the request specifying the movie or tv show

Returns:

the response indicating the status of the request

See Also:

• AddFavoriteRequest
• AddFavoriteResponse

addWatchlist

public AddWatchlistResponse addWatchlist(@NonNull AddWatchlistRequest request)

Adds or removes a movie/TV show from an account's watch list.

Parameters:

request - the request specifying the move or tv show

Returns:

the response indicating the status of the request

See Also:

• AddWatchlistRequest
• AddWatchlistResponse

getFavoriteMovies

public GetFavoriteMoviesResponse getFavoriteMovies(@NonNull GetFavoriteMoviesRequest request)

Gets the list of favorite movies for an account.

Parameters:

request - the request

Returns:

the list of movies

See Also:

• GetFavoriteMoviesRequest
• GetFavoriteMoviesResponse

getFavoriteTvShows

public GetFavoriteTvShowsResponse getFavoriteTvShows(@NonNull GetFavoriteTvShowsRequest request)

Gets the list of favorite TV shows for an account.

Parameters:

request - the request

Returns:

the list of favorite TV shows

See Also:

• GetFavoriteTvShowsRequest
• GetFavoriteTvShowsResponse

getLists

public GetListsResponse getLists(@NonNull GetListsRequest request)

Gets the list of a user's configured lists.

Parameters:

request - the request

Returns:

the user's lists

See Also:

• GetListsRequest
• GetListsResponse

getRatedMovies

public GetRatedMoviesResponse getRatedMovies(@NonNull GetRatedMoviesRequest request)

Gets the list of movies that a user rated.

Parameters:

request - the request

Returns:

the list of rated movies

See Also:

• GetRatedMoviesRequest
• GetRatedMoviesResponse

getRatedTvShows

public GetRatedTvShowsResponse getRatedTvShows(@NonNull GetRatedTvShowsRequest request)

Gets the list of TV shows that a user rated.

Parameters:

request - the request

Returns:

the list of rated TV shows

See Also:

• GetRatedTvShowsRequest
• GetRatedTvShowsResponse

getRatedTvEpisodes

public GetRatedTvEpisodesResponse getRatedTvEpisodes(@NonNull GetRatedTvEpisodesRequest request)

Gets the list of TV show episodes that a user rated.

Parameters:

request - the request

Returns:

the list of TV show episodes

See Also:

• GetRatedTvEpisodesRequest
• GetRatedTvEpisodesResponse

getWatchlistMovies

public GetWatchlistMoviesResponse getWatchlistMovies(@NonNull GetWatchlistMoviesRequest request)

Gets the list of movies on a user's watchlist.

Parameters:

request - the request

Returns:

the list of movies

See Also:

• GetWatchlistMoviesRequest
• GetWatchlistMoviesResponse

getWatchlistTvShows

public GetWatchlistTvResponse getWatchlistTvShows(@NonNull GetWatchlistTvRequest request)

Gets the list of TV shows on a user's watchlist.

Parameters:

request - the request

Returns:

the list of TV shows

See Also:

• GetWatchlistTvRequest
• GetWatchlistTvResponse