com.omertron.themoviedbapi.methods

Class TmdbAccount

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbAccount

public class TmdbAccount
extends AbstractMethod

Class to hold the Account Methods

Author:

stuart.boston

Field Summary

Fields inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

Constructor and Description
TmdbAccount(String apiKey, HttpTools httpTools) Constructor

Method Summary

Modifier and Type	Method and Description
Account	getAccount(String sessionId) Get the basic information for an account.
ResultList<MovieBasic>	getFavoriteMovies(String sessionId, int accountId) Get the list of favorite movies for an account.
ResultList<TVBasic>	getFavoriteTv(String sessionId, int accountId) Get the list of favorite TV series for an account.
ResultList<MovieBasic>	getGuestRatedMovies(String guestSessionId, String language, Integer page, SortBy sortBy) Get a list of rated movies for a specific guest session id.
ResultList<MovieBasic>	getRatedMovies(String sessionId, int accountId, Integer page, String sortBy, String language) Get the list of rated movies (and associated rating) for an account.
ResultList<TVBasic>	getRatedTV(String sessionId, int accountId, Integer page, String sortBy, String language) Get the list of rated TV shows (and associated rating) for an account.
ResultList<UserList>	getUserLists(String sessionId, int accountId) Get all lists of a given user
ResultList<MovieBasic>	getWatchListMovie(String sessionId, int accountId, Integer page, String sortBy, String language) Get the list of movies on an accounts watch list.
ResultList<TVBasic>	getWatchListTV(String sessionId, int accountId, Integer page, String sortBy, String language) Get the list of movies on an accounts watch list.
StatusCode	modifyFavoriteStatus(String sessionId, int accountId, MediaType mediaType, int mediaId, boolean setFavorite) Add or remove a movie to an accounts favorite list.
StatusCode	modifyWatchList(String sessionId, int accountId, MediaType mediaType, Integer movieId, boolean addToWatchlist) Add or remove a movie to an accounts watch list.

Methods inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

getMediaChanges, getTypeReference, processWrapper, processWrapperList

Methods inherited from class java.lang.Object

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

Constructor Detail

TmdbAccount

public TmdbAccount(String apiKey,
                   HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getAccount

public Account getAccount(String sessionId)
                   throws MovieDbException

Get the basic information for an account. You will need to have a valid session id.

Parameters:

sessionId -

Returns:

Throws:

MovieDbException

getUserLists

public ResultList<UserList> getUserLists(String sessionId,
                                         int accountId)
                                  throws MovieDbException

Get all lists of a given user

Parameters:

sessionId -

accountId -

Returns:

The lists

Throws:

MovieDbException

getFavoriteMovies

public ResultList<MovieBasic> getFavoriteMovies(String sessionId,
                                                int accountId)
                                         throws MovieDbException

Get the list of favorite movies for an account.

Parameters:

sessionId -

accountId -

Returns:

Throws:

MovieDbException

getFavoriteTv

public ResultList<TVBasic> getFavoriteTv(String sessionId,
                                         int accountId)
                                  throws MovieDbException

Get the list of favorite TV series for an account.

Parameters:

sessionId -

accountId -

Returns:

Throws:

MovieDbException

modifyFavoriteStatus

public StatusCode modifyFavoriteStatus(String sessionId,
                                       int accountId,
                                       MediaType mediaType,
                                       int mediaId,
                                       boolean setFavorite)
                                throws MovieDbException

Add or remove a movie to an accounts favorite list.

Parameters:

sessionId -

accountId -

mediaType -

mediaId -

setFavorite -

Returns:

Throws:

MovieDbException

getRatedMovies

public ResultList<MovieBasic> getRatedMovies(String sessionId,
                                             int accountId,
                                             Integer page,
                                             String sortBy,
                                             String language)
                                      throws MovieDbException

Get the list of rated movies (and associated rating) for an account.

Parameters:

sessionId -

accountId -

page -

sortBy -

language -

Returns:

Throws:

MovieDbException

getRatedTV

public ResultList<TVBasic> getRatedTV(String sessionId,
                                      int accountId,
                                      Integer page,
                                      String sortBy,
                                      String language)
                               throws MovieDbException

Get the list of rated TV shows (and associated rating) for an account.

Parameters:

sessionId -

accountId -

page -

sortBy -

language -

Returns:

Throws:

MovieDbException

getWatchListMovie

public ResultList<MovieBasic> getWatchListMovie(String sessionId,
                                                int accountId,
                                                Integer page,
                                                String sortBy,
                                                String language)
                                         throws MovieDbException

Get the list of movies on an accounts watch list.

Parameters:

sessionId -

accountId -

page -

sortBy -

language -

Returns:

The watch list of the user

Throws:

MovieDbException

getWatchListTV

public ResultList<TVBasic> getWatchListTV(String sessionId,
                                          int accountId,
                                          Integer page,
                                          String sortBy,
                                          String language)
                                   throws MovieDbException

Get the list of movies on an accounts watch list.

Parameters:

sessionId -

accountId -

page -

sortBy -

language -

Returns:

The watch list of the user

Throws:

MovieDbException

modifyWatchList

public StatusCode modifyWatchList(String sessionId,
                                  int accountId,
                                  MediaType mediaType,
                                  Integer movieId,
                                  boolean addToWatchlist)
                           throws MovieDbException

Add or remove a movie to an accounts watch list.

Parameters:

sessionId -

accountId -

movieId -

mediaType -

addToWatchlist -

Returns:

Throws:

MovieDbException

getGuestRatedMovies

public ResultList<MovieBasic> getGuestRatedMovies(String guestSessionId,
                                                  String language,
                                                  Integer page,
                                                  SortBy sortBy)
                                           throws MovieDbException

Get a list of rated movies for a specific guest session id.

Parameters:

guestSessionId -

language -

page -

sortBy - only CREATED_AT_ASC or CREATED_AT_DESC is supported

Returns:

Throws:

MovieDbException