tmdb_api 2.1.1 tmdb_api: ^2.1.1 copied to clipboard
Dart client-side API package for TMDB.org API (https://www.themoviedb.org/).
tmdb_api #
A TheMovieDatabase client library for dart. To know more about TMDB visit offical site
Getting started #
-
Adding as dependencies
Add this to your package's pubspec.yaml file:
dependencies: tmdb_api: latest //visit tmdb for latest version number
-
Import it
Now in your Dart code, you can use:
import 'package:tmdb_api/tmdb_api.dart';
-
Create Instance
Now you need to create instance for
TMDB
andApiKeys
with your api keys.final tmdbWithCustomLogs = TMDB( //TMDB instance ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),//ApiKeys instance with your keys, );
-
Configuring console logs
There are 3 logconfigs presets avaliable.
ConfigLogger.showAll()
: development use.ConfigLogger.showRecommended()
: development use.ConfigLogger.showNone()
: production use.
You can add any off this presets to
logConfig
named parameter ofTMDB
instance Custom Logsfinal tmdbWithCustomLogs = TMDB( ApiKeys('Your API KEY', 'apiReadAccessTokenv4'), logConfig: ConfigLogger( showLogs: true,//must be true than only all other logs will be shown showErrorLogs: true, ), );
Example #
For getting Trending movies
Map result = await tmdb.v3.trending.getTrending(mediaType = MediaType.all,timeWindow = TimeWindow.day);
Custom Dio instance #
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
dio:Dio()// your own dio instance
);
Setting Default api data language #
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
defaultLanguage:'en-US'// sets default language for all supported endpoints
);
Adding Interceptors #
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
interceptors:Interceptors()..add(/*your interceptor*/)
);
or
final customDio = Dio();
customDio.interceptors.add(/*your interceptor*/)
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
dio:dio
);
note:Use interceptors only when you are not using a custom Dio
instance.