com.jakewharton.trakt.services
Class ShowService.ScrobbleBuilder

java.lang.Object
  extended by com.jakewharton.apibuilder.ApiBuilder
      extended by com.jakewharton.trakt.TraktApiBuilder<Response>
          extended by com.jakewharton.trakt.services.ShowService.ScrobbleBuilder
Enclosing class:
ShowService

public static final class ShowService.ScrobbleBuilder
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.ScrobbleBuilder duration(int duration)
          Duration (in minutes).
 ShowService.ScrobbleBuilder episode(int episode)
          Show episode.
 ShowService.ScrobbleBuilder imdbId(String imdbId)
          IMDB ID for the show.
protected  void performValidation()
          Perform any required validation before firing off the request.
 ShowService.ScrobbleBuilder progress(int progress)
          Percent progress (0-100).
 ShowService.ScrobbleBuilder season(int season)
          Show season.
 ShowService.ScrobbleBuilder title(String title)
          Movie title.
 ShowService.ScrobbleBuilder tvdbId(int tmdbId)
          TVDB ID for the show.
 ShowService.ScrobbleBuilder 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.ScrobbleBuilder imdbId(String imdbId)
IMDB ID for the show.

Parameters:
imdbId - Value.
Returns:
Builder instance.

tvdbId

public ShowService.ScrobbleBuilder tvdbId(int tmdbId)
TVDB ID for the show.

Parameters:
tmdbId - Value.
Returns:
Builder instance.

title

public ShowService.ScrobbleBuilder title(String title)
Movie title.

Parameters:
title - Value.
Returns:
Builder instance.

year

public ShowService.ScrobbleBuilder year(int year)
Movie year.

Parameters:
year - Value.
Returns:
Builder instance.

season

public ShowService.ScrobbleBuilder season(int season)
Show season. Send 0 if watching a special.

Parameters:
season - Value.
Returns:
Builder instance.

episode

public ShowService.ScrobbleBuilder episode(int episode)
Show episode.

Parameters:
episode - Value.
Returns:
Builder instance.

duration

public ShowService.ScrobbleBuilder duration(int duration)
Duration (in minutes).

Parameters:
duration - Value.
Returns:
Builder instance.

progress

public ShowService.ScrobbleBuilder 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>


Copyright © 2011 Jake Wharton. All Rights Reserved.