com.jakewharton.trakt.services
Class ShowService.WatchingBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.trakt.TraktApiBuilder<Response>
          com.jakewharton.trakt.services.ShowService.WatchingBuilder

Enclosing class:

ShowService

public static final class ShowService.WatchingBuilder
extends TraktApiBuilder<Response>

Nested Class Summary

Nested classes/interfaces inherited from class com.jakewharton.trakt.TraktApiBuilder

TraktApiBuilder.HttpMethod

Field Summary

Fields inherited from class com.jakewharton.trakt.TraktApiBuilder

FIELD_API_KEY, FIELD_DATE, FIELD_DAYS, FIELD_EPISODE, FIELD_EXTENDED, FIELD_QUERY, FIELD_SEASON, FIELD_TITLE, FIELD_USERNAME

Fields inherited from class com.jakewharton.apibuilder.ApiBuilder

API_URL_DELIMITER_END, API_URL_DELIMITER_START

Method Summary

ShowService.WatchingBuilder	duration(int duration) Duration (in minutes).
ShowService.WatchingBuilder	episode(int episode) Show episode.
ShowService.WatchingBuilder	imdbId(String imdbId) IMDB ID for the show.
protected void	performValidation() Perform any required validation before firing off the request.
ShowService.WatchingBuilder	progress(int progress) Percent progress (0-100).
ShowService.WatchingBuilder	season(int season) Show season.
ShowService.WatchingBuilder	title(String title) Movie title.
ShowService.WatchingBuilder	tvdbId(int tmdbId) TVDB ID for the show.
ShowService.WatchingBuilder	year(int year) Movie year.

Methods inherited from class com.jakewharton.trakt.TraktApiBuilder

dateToUnixTimestamp, execute, field, field, fire, hasPostParameter, includeDebugStrings, parameter, parameter, parameter, postFireCallback, postParameter, postParameter, postParameter, postParameter, preFireCallback, print

Methods inherited from class com.jakewharton.apibuilder.ApiBuilder

buildUrl, buildUrl, encodeUrl, field, field, field, field, field, hasField, hasParameter, parameter, parameter, parameter, parameter

Methods inherited from class java.lang.Object

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

Method Detail

imdbId

public ShowService.WatchingBuilder imdbId(String imdbId)

IMDB ID for the show.

Parameters:

imdbId - Value.

Returns:

Builder instance.

tvdbId

public ShowService.WatchingBuilder tvdbId(int tmdbId)

TVDB ID for the show.

Parameters:

tmdbId - Value.

Returns:

Builder instance.

title

public ShowService.WatchingBuilder title(String title)

Movie title.

Parameters:

title - Value.

Returns:

Builder instance.

year

public ShowService.WatchingBuilder year(int year)

Movie year.

Parameters:

year - Value.

Returns:

Builder instance.

season

public ShowService.WatchingBuilder season(int season)

Show season. Send 0 if watching a special.

Parameters:

season - Value.

Returns:

Builder instance.

episode

public ShowService.WatchingBuilder episode(int episode)

Show episode.

Parameters:

episode - Value.

Returns:

Builder instance.

duration

public ShowService.WatchingBuilder duration(int duration)

Duration (in minutes).

Parameters:

duration - Value.

Returns:

Builder instance.

progress

public ShowService.WatchingBuilder progress(int progress)

Percent progress (0-100). It is recommended to call the watching API every 15 minutes, then call the scrobble API near the end of the movie to lock it in.

Parameters:

progress - Value.

Returns:

Builder instance.

performValidation

protected void performValidation()

Description copied from class: TraktApiBuilder

Perform any required validation before firing off the request.

Overrides:

performValidation in class TraktApiBuilder<Response>