Network.API.TheMovieDB.Internal.Configuration

Internal configuration information for TheMovieDB API.

Documentation

data Configuration

TheMovieDB API tries to preserve bandwidth by omitting information (such as full URLs for poster images) from most of the API calls. Therefore in order to construct a complete URL for a movie poster you'll need to use the config function to retrieve API configuration information.

A helper function is provided (moviePosterURLs) that constructs a list of all poster URLs given a Movie and Configuration.

According to the API documentation for TheMovieDB, you should cache the Configuration value and only request it every few days. Therefore, it is an instance of the Binary class so it can be serialized to and from a cache file on disk.

Alternatively, the FromJSON and ToJSON instances can be used to cache the Configuration value.

Constructors

Configuration

Fields

• cfgImageBaseURL :: Text

  The base URL for images.

• cfgImageSecBaseURL :: Text

  Base URL for secure images.

• cfgPosterSizes :: [Text]

  List of possible image sizes.

Instances

Generic Configuration

Associated Types

type Rep Configuration :: * -> *

Methods

from :: Configuration -> Rep Configuration x

to :: Rep Configuration x -> Configuration

ToJSON Configuration

Methods

toJSON :: Configuration -> Value

toEncoding :: Configuration -> Encoding

toJSONList :: [Configuration] -> Value

toEncodingList :: [Configuration] -> Encoding

FromJSON Configuration

Methods

parseJSON :: Value -> Parser Configuration

parseJSONList :: Value -> Parser [Configuration]

Binary Configuration

Methods

put :: Configuration -> Put

get :: Get Configuration

putList :: [Configuration] -> Put

type Rep Configuration

type Rep Configuration = D1 * (MetaData "Configuration" "Network.API.TheMovieDB.Internal.Configuration" "themoviedb-1.1.4.0-FWYrHG7HF9U5GVdYlX5Pjb" False) (C1 * (MetaCons "Configuration" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "cfgImageBaseURL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "cfgImageSecBaseURL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "cfgPosterSizes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Text])))))

posterURLs :: Configuration -> Text -> [Text]

Return a list of URLs for all possible posters posters.