Recurrent classes & concepts

Slim variants

Slims are classes with fewer data in comparison to its normal variant. They’re used in search results (= lists), so TmdbMovie.Slim doesn’t contain data such as production countries and companies for example.

TmdbPage<Type>

This class represents a page of items for the given type, for example TmdbPage<TmdbMovie.Slim>. Pages are used primarily in searches or e.g. movie/tv show recommendations where you can specify the actual page. → Doc

TmdbImage

TmdbImage is used for all image paths including poster, backdrop and still paths.

If the images are standalone - for example a poster or backdrop as part of a movie - they don’t contain additional data like width and height. These are available for concrete calls only like <Service>.posters(id) or if AppendToResponse.Item.IMAGE is used.

The class supports the method get(Quality) which produces the full link to the image resource. → Doc

TmdbDate

TmdbDate is a wrapper class for LocalDate which supports the method localize(Locale, Format) to return a date string according to the user’s location. → Doc

TmdbError

If there is an server error during networking this class is returned (requires check for NetworkResponse.ServerError). In most scenarios TmdbError.DefaultError is returned which is caused by not-found resources often. TmdbError.PostError will be returned if malformed data is passed to the body. → Doc

TmdbMessage

This class is used for calls which return status data and simple data like access token and account related messages (id, successfull update data etc.). It contains sub-classes which provide the essential data. → Doc

TmdbBody

TmdbBody‘s inner classes are used to pass data for updating account related data in AccountService, for example adding items to a list or update its description (set valid session id required). → Doc

AppendToResponse

Some classes support optional addable data like videos or images which can be retrieved directly in the details call. Classes supporting the functionality: TmdbShow, TmdbSeason, TmdbEpisode, TmdbMovie, TmdbPerson

For more info how it works you should look on the official TMDb page and in Recipes for examples. → Doc

Enumerations

All available enumerations are listed here: Github