com.jakewharton.trakt.services
Class ShowService

java.lang.Object
  extended by com.jakewharton.apibuilder.ApiService
      extended by com.jakewharton.trakt.TraktApiService
          extended by com.jakewharton.trakt.services.ShowService

public class ShowService
extends TraktApiService


Nested Class Summary
static class ShowService.CancelWatchingBuilder
           
static class ShowService.EpisodeLibraryBuilder
           
static class ShowService.EpisodeSeenBuilder
           
static class ShowService.EpisodeShoutsBuilder
           
static class ShowService.EpisodeSummaryBuilder
           
static class ShowService.EpisodeUnlibraryBuilder
           
static class ShowService.EpisodeUnseenBuilder
           
static class ShowService.EpisodeUnwatchlistBuilder
           
static class ShowService.EpisodeWatchingNowBuilder
           
static class ShowService.EpisodeWatchlistBuilder
           
static class ShowService.ScrobbleBuilder
           
static class ShowService.SeasonBuilder
           
static class ShowService.SeasonsBuilder
           
static class ShowService.ShoutsBuilder
           
static class ShowService.SummaryBuilder
           
static class ShowService.TrendingBuilder
           
static class ShowService.UnlibraryBuilder
           
static class ShowService.UnwatchlistBuilder
           
static class ShowService.WatchingBuilder
           
static class ShowService.WatchingNowBuilder
           
static class ShowService.WatchlistBuilder
           
 
Field Summary
 
Fields inherited from class com.jakewharton.apibuilder.ApiService
CONTENT_ENCODING
 
Constructor Summary
ShowService()
           
 
Method Summary
 ShowService.CancelWatchingBuilder cancelWatching()
          Notify Trakt that a user has stopped watching a show.
 ShowService.EpisodeLibraryBuilder episodeLibrary(int tvdbId)
          Add unwatched episodes to your library.
 ShowService.EpisodeLibraryBuilder episodeLibrary(String imdbId)
          Add unwatched episodes to your library.
 ShowService.EpisodeLibraryBuilder episodeLibrary(String title, int year)
          Add unwatched episodes to your library.
 ShowService.EpisodeSeenBuilder episodeSeen(int tvdbId)
          Add episodes watched outside of trakt to your library.
 ShowService.EpisodeSeenBuilder episodeSeen(String imdbId)
          Add episodes watched outside of trakt to your library.
 ShowService.EpisodeSeenBuilder episodeSeen(String title, int year)
          Add episodes watched outside of trakt to your library.
 ShowService.EpisodeShoutsBuilder episodeShouts(int tvdbId, int season, int episode)
          Returns all shouts for an episode.
 ShowService.EpisodeShoutsBuilder episodeShouts(String title, int season, int episode)
          Returns all shouts for an episode.
 ShowService.EpisodeSummaryBuilder episodeSummary(int tvdbId, int season, int episode)
          Returns information for an episode including ratings.
 ShowService.EpisodeSummaryBuilder episodeSummary(String title, int season, int episode)
          Returns information for an episode including ratings.
 ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(int tvdbId)
          Remove episodes from your library collection.
 ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(String imdbId)
          Remove episodes from your library collection.
 ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(String title, int year)
          Remove episodes from your library collection.
 ShowService.EpisodeUnseenBuilder episodeUnseen(int tvdbId)
          Remove episodes watched outside of trakt from your library.
 ShowService.EpisodeUnseenBuilder episodeUnseen(String imdbId)
          Remove episodes watched outside of trakt from your library.
 ShowService.EpisodeUnseenBuilder episodeUnseen(String title, int year)
          Remove episodes watched outside of trakt from your library.
 ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(int tvdbId)
          Remove one or more episodes for a specific show from your watchlist.
 ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(String imdbId)
          Remove one or more episodes for a specific show from your watchlist.
 ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(String title, int year)
          Remove one or more episodes for a specific show from your watchlist.
 ShowService.EpisodeWatchingNowBuilder episodeWatchingNow(String title, int season, int episode)
          Returns a array of all users watching an episode.
 ShowService.EpisodeWatchlistBuilder episodeWatchlist(int tvdbId)
          Add one or more episodes for a specific show to your watchlist.
 ShowService.EpisodeWatchlistBuilder episodeWatchlist(String imdbId)
          Add one or more episodes for a specific show to your watchlist.
 ShowService.EpisodeWatchlistBuilder episodeWatchlist(String title, int year)
          Add one or more episodes for a specific show to your watchlist.
 ShowService.ScrobbleBuilder scrobble(int tvdbId)
          Notify Trakt that a user has finished watching a show.
 ShowService.ScrobbleBuilder scrobble(String imdbId)
          Notify Trakt that a user has finished watching a show.
 ShowService.ScrobbleBuilder scrobble(String title, int year)
          Notify Trakt that a user has finished watching a show.
 ShowService.SeasonBuilder season(String query, int season)
          Returns detailed episode info for a specific season of a show.
 ShowService.SeasonsBuilder seasons(String query)
          Returns basic season info for a show.
 ShowService.ShoutsBuilder shouts(int tvdbId)
          Returns all shouts for a show.
 ShowService.ShoutsBuilder shouts(String title)
          Returns all shouts for a show.
 ShowService.SummaryBuilder summary(String title)
          Returns information for a TV show including ratings, top watchers, and most watched episodes.
 ShowService.TrendingBuilder trending()
          Returns all shows being watched right now.
 ShowService.UnlibraryBuilder unlibrary(int tvdbId)
          Remove an entire show (including all episodes) from your library collection.
 ShowService.UnlibraryBuilder unlibrary(String imdbId)
          Remove an entire show (including all episodes) from your library collection.
 ShowService.UnlibraryBuilder unlibrary(String title, int year)
          Remove an entire show (including all episodes) from your library collection.
 ShowService.UnwatchlistBuilder unwatchlist()
          Remove one or more shows from your watchlist.
 ShowService.WatchingBuilder watching(int tvdbId)
          Notify Trakt that a user has started watching a show.
 ShowService.WatchingBuilder watching(String imdbId)
          Notify Trakt that a user has started watching a show.
 ShowService.WatchingBuilder watching(String title, int year)
          Notify Trakt that a user has started watching a show.
 ShowService.WatchingNowBuilder watchingNow(String query)
          Returns a array of all users watching a show.
 ShowService.WatchlistBuilder watchlist()
          Add one or more shows to your watchlist.
 
Methods inherited from class com.jakewharton.trakt.TraktApiService
get, post, setApiKey, setAuthentication, setMediaCenterDate, setMediaCenterVersion, setPluginVersion, setUseSsl, unmarshall, unmarshall, unmarshall
 
Methods inherited from class com.jakewharton.apibuilder.ApiService
acceptGzip, addRequestHeader, closeConnection, closeStream, convertStreamToString, executeDelete, executeDelete, executeGet, executeGet, executeMethod, executePost, executePost, getConnectTimeout, getParametersString, getReadTimeout, getRequestHeader, getRequestHeaderNames, getWrappedInputStream, removeRequestHeader, setConnectTimeout, setReadTimeout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShowService

public ShowService()
Method Detail

cancelWatching

public ShowService.CancelWatchingBuilder cancelWatching()

Notify Trakt that a user has stopped watching a show.

Warning: This method requires a developer API key.

Returns:
Builder instance.

episodeLibrary

public ShowService.EpisodeLibraryBuilder episodeLibrary(String imdbId)
Add unwatched episodes to your library.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeLibrary

public ShowService.EpisodeLibraryBuilder episodeLibrary(int tvdbId)
Add unwatched episodes to your library.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeLibrary

public ShowService.EpisodeLibraryBuilder episodeLibrary(String title,
                                                        int year)
Add unwatched episodes to your library.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

episodeSeen

public ShowService.EpisodeSeenBuilder episodeSeen(String imdbId)
Add episodes watched outside of trakt to your library.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeSeen

public ShowService.EpisodeSeenBuilder episodeSeen(int tvdbId)
Add episodes watched outside of trakt to your library.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeSeen

public ShowService.EpisodeSeenBuilder episodeSeen(String title,
                                                  int year)
Add episodes watched outside of trakt to your library.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

episodeSummary

public ShowService.EpisodeSummaryBuilder episodeSummary(int tvdbId,
                                                        int season,
                                                        int episode)
Returns information for an episode including ratings.

Parameters:
tvdbId - The TVDB ID.
season - The season number. Use 0 if you want the specials.
episode - The episode number.
Returns:
Builder instance.

episodeSummary

public ShowService.EpisodeSummaryBuilder episodeSummary(String title,
                                                        int season,
                                                        int episode)
Returns information for an episode including ratings.

Parameters:
title - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
season - The season number. Use 0 if you want the specials.
episode - The episode number.
Returns:
Builder instance.

episodeUnlibrary

public ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(String imdbId)
Remove episodes from your library collection.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeUnlibrary

public ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(int tvdbId)
Remove episodes from your library collection.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeUnlibrary

public ShowService.EpisodeUnlibraryBuilder episodeUnlibrary(String title,
                                                            int year)
Remove episodes from your library collection.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

episodeUnseen

public ShowService.EpisodeUnseenBuilder episodeUnseen(String imdbId)
Remove episodes watched outside of trakt from your library.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeUnseen

public ShowService.EpisodeUnseenBuilder episodeUnseen(int tvdbId)
Remove episodes watched outside of trakt from your library.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeUnseen

public ShowService.EpisodeUnseenBuilder episodeUnseen(String title,
                                                      int year)
Remove episodes watched outside of trakt from your library.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

episodeUnwatchlist

public ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(String imdbId)
Remove one or more episodes for a specific show from your watchlist.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeUnwatchlist

public ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(int tvdbId)
Remove one or more episodes for a specific show from your watchlist.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeUnwatchlist

public ShowService.EpisodeUnwatchlistBuilder episodeUnwatchlist(String title,
                                                                int year)
Remove one or more episodes for a specific show from your watchlist.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

episodeWatchingNow

public ShowService.EpisodeWatchingNowBuilder episodeWatchingNow(String title,
                                                                int season,
                                                                int episode)
Returns a array of all users watching an episode.

Parameters:
title - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
season - The season number. Use 0 if you want the specials.
episode - The episode number.
Returns:
Builder instance.

episodeWatchlist

public ShowService.EpisodeWatchlistBuilder episodeWatchlist(String imdbId)
Add one or more episodes for a specific show to your watchlist.

Parameters:
imdbId - Show IMDB ID.
Returns:
Builder instance.

episodeWatchlist

public ShowService.EpisodeWatchlistBuilder episodeWatchlist(int tvdbId)
Add one or more episodes for a specific show to your watchlist.

Parameters:
tvdbId - Show TVDB ID.
Returns:
Builder instance.

episodeWatchlist

public ShowService.EpisodeWatchlistBuilder episodeWatchlist(String title,
                                                            int year)
Add one or more episodes for a specific show to your watchlist.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

scrobble

public ShowService.ScrobbleBuilder scrobble(String imdbId)

Notify Trakt that a user has finished watching a show. This commits the show to the users profile. You should use show/watching prior to calling this method.

Warning: This method requires a developer API key.

Parameters:
imdbId - IMDB ID for the show.
Returns:
Builder instance.

scrobble

public ShowService.ScrobbleBuilder scrobble(int tvdbId)

Notify Trakt that a user has finished watching a show. This commits the show to the users profile. You should use show/watching prior to calling this method.

Warning: This method requires a developer API key.

Parameters:
tvdbId - TVDB ID for the show.
Returns:
Builder instance.

scrobble

public ShowService.ScrobbleBuilder scrobble(String title,
                                            int year)

Notify Trakt that a user has finished watching a show. This commits the show to the users profile. You should use show/watching prior to calling this method.

Warning: This method requires a developer API key.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

season

public ShowService.SeasonBuilder season(String query,
                                        int season)
Returns detailed episode info for a specific season of a show.

Parameters:
query - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
season - The season number. Use 0 if you want the specials.
Returns:
Builder instance.

seasons

public ShowService.SeasonsBuilder seasons(String query)
Returns basic season info for a show.

Parameters:
query - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
Returns:
Builder instance.

summary

public ShowService.SummaryBuilder summary(String title)
Returns information for a TV show including ratings, top watchers, and most watched episodes.

Parameters:
title - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
Returns:
Builder instance.

trending

public ShowService.TrendingBuilder trending()
Returns all shows being watched right now.

Returns:
Builder instance.

unlibrary

public ShowService.UnlibraryBuilder unlibrary(String imdbId)
Remove an entire show (including all episodes) from your library collection.

Parameters:
imdbId - IMDB ID for the show.
Returns:
Builder instance.

unlibrary

public ShowService.UnlibraryBuilder unlibrary(int tvdbId)
Remove an entire show (including all episodes) from your library collection.

Parameters:
tvdbId - TVDB ID for the show.
Returns:
Builder instance.

unlibrary

public ShowService.UnlibraryBuilder unlibrary(String title,
                                              int year)
Remove an entire show (including all episodes) from your library collection.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

unwatchlist

public ShowService.UnwatchlistBuilder unwatchlist()
Remove one or more shows from your watchlist.

Returns:
Builder instance.

watching

public ShowService.WatchingBuilder watching(String imdbId)

Notify Trakt that a user has started watching a show.

Warning: This method requires a developer API key.

Parameters:
imdbId - IMDB ID for the show.
Returns:
Builder instance.

watching

public ShowService.WatchingBuilder watching(int tvdbId)

Notify Trakt that a user has started watching a show.

Warning: This method requires a developer API key.

Parameters:
tvdbId - TVDB ID for the show.
Returns:
Builder instance.

watching

public ShowService.WatchingBuilder watching(String title,
                                            int year)

Notify Trakt that a user has started watching a show.

Warning: This method requires a developer API key.

Parameters:
title - Show title.
year - Show year.
Returns:
Builder instance.

watchingNow

public ShowService.WatchingNowBuilder watchingNow(String query)
Returns a array of all users watching a show.

Parameters:
query - Either the slug (i.e. the-walking-dead) or TVDB ID. You can get a show's slug by browsing the website and looking at the URL when on a show summary page.
Returns:
Builder instance.

watchlist

public ShowService.WatchlistBuilder watchlist()
Add one or more shows to your watchlist.

Returns:
Builder instance.

shouts

public ShowService.ShoutsBuilder shouts(String title)
Returns all shouts for a show. Most recent shouts returned first.

Parameters:
title - Show title.
Returns:
Builder instance.

shouts

public ShowService.ShoutsBuilder shouts(int tvdbId)
Returns all shouts for a show. Most recent shouts returned first.

Parameters:
tvdbId - TVDB ID.
Returns:
Builder instance.

episodeShouts

public ShowService.EpisodeShoutsBuilder episodeShouts(String title,
                                                      int season,
                                                      int episode)
Returns all shouts for an episode. Most recent shouts returned first.

Parameters:
title - Show title.
season - The season number. Use 0 if you want the specials.
episode - The episode number.
Returns:
Builder instance.

episodeShouts

public ShowService.EpisodeShoutsBuilder episodeShouts(int tvdbId,
                                                      int season,
                                                      int episode)
Returns all shouts for an episode. Most recent shouts returned first.

Parameters:
tvdbId - TMDB ID.
season - The season number. Use 0 if you want the specials.
episode - The episode number.
Returns:
Builder instance.


Copyright © 2011 Jake Wharton. All Rights Reserved.