Copyright	This file is part of the package themoviedb. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at: https://github.com/pjones/themoviedb No part of this package including this file may be copied modified propagated or distributed except according to the terms contained in the LICENSE file.
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.API.TheMovieDB.Internal.Configuration

Description

Internal configuration information for TheMovieDB API.

Synopsis

data Configuration = Configuration {
- cfgImageBaseURL :: Text
- cfgImageSecBaseURL :: Text
- cfgPosterSizes :: [Text]
}
posterURLs :: Configuration -> Text -> [Text]

Documentation

data Configuration Source #

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.

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

Instances details

FromJSON Configuration Source #
Instance details Defined in Network.API.TheMovieDB.Internal.Configuration Methods parseJSON :: Value -> Parser Configuration # parseJSONList :: Value -> Parser [Configuration] #
ToJSON Configuration Source #
Instance details Defined in Network.API.TheMovieDB.Internal.Configuration Methods toJSON :: Configuration -> Value # toEncoding :: Configuration -> Encoding # toJSONList :: [Configuration] -> Value # toEncodingList :: [Configuration] -> Encoding #
Generic Configuration Source #
Instance details Defined in Network.API.TheMovieDB.Internal.Configuration Associated Types type Rep Configuration :: Type -> Type # Methods from :: Configuration -> Rep Configuration x # to :: Rep Configuration x -> Configuration #
type Rep Configuration Source #
Instance details Defined in Network.API.TheMovieDB.Internal.Configuration type Rep Configuration = D1 ('MetaData "Configuration" "Network.API.TheMovieDB.Internal.Configuration" "themoviedb-1.2.2-BJmi1ZfYUxmEKyi1Jn9JiM" 'False) (C1 ('MetaCons "Configuration" 'PrefixI 'True) (S1 ('MetaSel ('Just "cfgImageBaseURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "cfgImageSecBaseURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "cfgPosterSizes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))))

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

Return a list of URLs for all possible posters.