Skip to content
This repository has been archived by the owner on Dec 6, 2022. It is now read-only.

Latest commit

 

History

History
97 lines (83 loc) · 2.85 KB

README.md

File metadata and controls

97 lines (83 loc) · 2.85 KB

Dart pub analyser Run Tests CI pub package

tmdb_api

A TheMovieDatabase client library for dart. To know more about TMDB visit offical site

Avaliable Methods

v3( 🎊✨ Completed 🎉🎉)

Supports all the functions of version 3 of tmdb API

  • Auth
  • Account
  • Guest Sessions
  • Movies
  • Tv shows
  • Tv Seasons
  • Tv Episodes
  • People
  • Credits
  • Certification
  • Changes
  • Collections
  • Find
  • Genres
  • Keywords
  • Companies
  • Trending
  • Search
  • Discover
  • Networks
  • Reviews
  • Versions
  • Lists

v4(🎊✨ Completed 🎉🎉)

  • Image URL Constructor
  • auth
  • account
  • lists

Getting started

(updated on v1.2.4)

Step 1: Adding as dependencies

Pub.dev's installation guide

Add this to your package's pubspec.yaml file:

dependencies:
  tmdb_api: ^1.2.4 //visit tmdb for latest version number

Step 2: Import it

Now in your Dart code, you can use:

import 'package:tmdb_api/tmdb_api.dart';

Step 3: Create Instance

Now you need to create instance for TMDB and ApiKeys with your api keys.

TMDB tmdbWithCustomLogs = TMDB( //TMDB instance
    ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),//ApiKeys instance with your keys,
  );

Step 4(Optional): 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 of TMDB instance

Custom Logs

TMDB 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);

For more API documentation

visit offical API documentation