core library
Core is the library which will handle the core functionality related to the filmy gyaan SDK.
Classes
- AlternativeTitlesParams
- A parameter class which will be used to make the initial request for getting the alternative titles of movie.
- AuthorDetails
- BelongsToCollection
- Cast
- Certification
- CertificationsMoviesParams
- A parameter class which will be used to make the initial request for getting the movies certifications.
- CertificationsTvParams
- A parameter class which will be used to make the initial request for getting the tv certifications.
- CombinedCredits
- Constants
- A set of constants which will be used in the SDK.
- ContentRatingsResult
- Core
- Provides a Core object which will be used to handle all the core related work. Like initializing MQTT, making request, etc.
- CreatedBy
- Credentials
- Represents a configuration for a given api key.
- CreditsParams
- A parameter class which will be used to make the initial request for getting the credits of the movie.
- Data
- Dates
- DefaultResult
- Provides a DefaultResult which contains the error or any message which will be used to send an FilmGyaanException to the application.
- Ensure
- Provides Ensure object which will check all the parameters if they are valid or not.
- EpisodeGroupsResult
- ExternalIdsParams
- A parameter class which will be used to make the initial request for getting the external ids of the movie.
-
Fiber<
T> - Provides a Fibre object.
- ILogger
- The abstract class which will be used to make the calls for printing any messages on the console.
- ImagesParams
- A parameter class which will be used to make the initial request for getting the images of the movie.
- INetworkingModule
- A network module which will be used to handle the request.
- IRequestHandler
- A class which will be used to start the request.
- IResponse
- A class which will contain the response of the IRequestHandler.
- Job
- KeywordDetailsParams
- A parameter class which will be used to make the initial request for getting the keyword details.
- KeywordMoviesParams
- A parameter class which will be used to make the initial request for getting the keyword movies.
- KeywordsParams
- A parameter class which will be used to make the initial request for getting the keywords of the movie.
- KnownFor
- LatestMovieParams
- A parameter class which will be used to make the initial request for getting the latest movie.
- LazyLogger
- The main class which will initiate the log calls.
- Level
- Represents the level of a log record.
- Log
- Inner logger class which will be used for printing the logs.
- Media
- MovieInformationParams
- A parameter class which will be used to make the initial request for getting the movie details.
- MovieListsParams
- A parameter class which will be used to make the initial request for getting the lists in which the movie belongs to.
- MoviesGenreParams
- A parameter class which will be used to make the initial request for getting the movies genre.
- Network
- NetworkingModule
- Provides a NetworkingModule to the Core.
- NowPlayingMoviesParams
- A parameter class which will be used to make the initial request for getting the now playing movies.
- Parameters
- Represents all the data necessary to make a request to the API.
- PeopleDetailsParams
- A parameter class which will be used to make the initial request for getting the details of the people.
- PeopleExternalIdParams
- A parameter class which will be used to make the initial request for getting the external id of the people.
- PeopleImagesParams
- A parameter class which will be used to make the initial request for getting the images of the people.
- PeopleLatestParams
- A parameter class which will be used to make the initial request for getting the latest people.
- PeopleMovieCreditsParams
- A parameter class which will be used to make the initial request for getting the movie credits of the people.
- PeopleMovieTvCreditsParams
- A parameter class which will be used to make the initial request for getting the movie and tv credits of the people.
- PeopleTaggedImagesParams
- A parameter class which will be used to make the initial request for getting the tagged images of the people.
- PeopleTaggedImagesResult
- PeopleTranslationsParams
- A parameter class which will be used to make the initial request for getting the translations of the people.
- PeopleTvCreditsParams
- A parameter class which will be used to make the initial request for getting the tv credits of the people.
- PersonDetailsCast
- PopularMoviesParams
- A parameter class which will be used to make the initial request for getting the popular movies.
- PopularPersonParams
- A parameter class which will be used to make the initial request for getting the popular person.
- ProductionCompany
- Profile
- Recommendations
- RecommendationsParams
- A parameter class which will be used to make the initial request for getting the recommended movies related to movie.
- RecommendationsResult
- ReleaseDate
- ReleaseDatesParams
- A parameter class which will be used to make the initial request for getting the release dates of the movie.
- ReleaseDatesResult
- Request
- Provides a Request which will contain the details for the request which needs to be done.
- RequestHandler
- Provides the RequestHandler.
- Response
- A response class which will contains all the required details of the request made.
- Result
- Represents the response from an API.
- Results
- ReviewDetailsParams
- A parameter class which will be used to make the initial request for getting the reviews details.
- ReviewsParams
- A parameter class which will be used to make the initial request for getting the reviews related to movie.
- Role
- Season
- SimilarParams
- A parameter class which will be used to make the initial request for getting the similar movies related to movie.
- TEpisodeToAir
- Title
- TopRatedMoviesParams
- A parameter class which will be used to make the initial request for getting the top rated movies.
- Translation
- TranslationsParams
- A parameter class which will be used to make the initial request for getting translations of the movie.
- TvAggregateCreditsParams
- A parameter class which will be used to make the initial request for getting the tv aggregate credits.
- TvAiringTodayParams
- A parameter class which will be used to make the initial request for getting the tv airing today.
- TvAlternativeTitlesParams
- A parameter class which will be used to make the initial request for getting the tv alternative title.
- TvContentRatingsParams
- A parameter class which will be used to make the initial request for getting the tv content ratings.
- TvCreditsParams
- A parameter class which will be used to make the initial request for getting the tv credits.
- TvData
- TvDetailsParams
- A parameter class which will be used to make the initial request for getting the tv details.
- TvEpisodeGroupsParams
- A parameter class which will be used to make the initial request for getting the tv episode groups.
- TvExternalIdsParams
- A parameter class which will be used to make the initial request for getting the tv external ids.
- TvGenreParams
- A parameter class which will be used to make the initial request for getting the tv genre.
- TvImagesParams
- A parameter class which will be used to make the initial request for getting the tv images.
- TvKeywordsParams
- A parameter class which will be used to make the initial request for getting the tv keywords.
- TvLatestParams
- A parameter class which will be used to make the initial request for getting the tv latest.
- TvOnAirParams
- A parameter class which will be used to make the initial request for getting the tv on the air today.
- TvPopularParams
- A parameter class which will be used to make the initial request for getting the tv popular.
- TvRecommendationsParams
- A parameter class which will be used to make the initial request for getting the tv recommendations.
- TvRecommendationsResult
- TvReviewsParams
- A parameter class which will be used to make the initial request for getting the tv reviews.
- TvScreenedTheatricallyParams
- A parameter class which will be used to make the initial request for getting the tv screened theatrically.
- TvSimilarParams
- A parameter class which will be used to make the initial request for getting the tv similar.
- TvTopRatedParams
- A parameter class which will be used to make the initial request for getting the tv top rated.
- TvTranslationsParams
- A parameter class which will be used to make the initial request for getting the tv translations.
- TvVideosParams
- A parameter class which will be used to make the initial request for getting the tv videos.
- UpcomingMoviesParams
- A parameter class which will be used to make the initial request for getting the upcoming movies.
- VideosParams
- A parameter class which will be used to make the initial request for getting videos of the movie.
- VideosResult
- WatchProviderRegionsResult
- WatchProvidersMovieResult
- WatchProvidersMoviesParams
- A parameter class which will be used to make the initial request for getting the watch providers movies.
- WatchProvidersRegionsParams
- A parameter class which will be used to make the initial request for getting the watch providers regions.
- WatchProvidersTvParams
- A parameter class which will be used to make the initial request for getting the watch providers tv.
- WatchProvidersTvResult
Enums
- RequestType
- A set of RequestType which will be used to make different calls
Mixins
- CertificationsDx
- A mixin for Movies which will be handling all the request made related to certifications
- GenreDx
- A mixin for Movies which will be handling all the request made related to genre
- KeywordsDx
- A mixin for Movies which will be handling all the request made related to keywords
- MoviesDx
- A mixin for Movies which will be handling all the request made related to movies
- PeopleDx
- A mixin for People which will be handling all the request made related to people
- ReviewsDx
- A mixin for People which will be handling all the request made related to reviews
- TvDx
- A mixin for People which will be handling all the request made related to tv
- WatchProvidersDx
- A mixin for People which will be handling all the request made related to watch providers
Extensions
- RequestTypeExtension on RequestType
- An extension on RequestType to get the details related to the request like the type and other time out parameters.
Functions
-
defaultFlow<
P extends Parameters, R extends Result> ({required Core core, required P params, required BodyDeserializer< R> serializer}) → Future<R> -
A method which will be used to make the http request
from the given
paramsand return the response of the typeR. -
getExceptionFromAny(
dynamic error) → FilmGyaanException - Returns the FilmGyaanException if any error occurs.
-
getExceptionFromDefaultResult(
DefaultResult result) → FilmGyaanException - Returns the FilmGyaanException by checking the DefaultResult.
-
injectLogger(
String id) → LazyLogger - Get a logger from the provider.
-
provideLogger<
R> (ILogger logger, Future< R> body()) → Future<R> -
Provides a
loggerto the code insidebody.
Typedefs
-
BodyDeserializer<
T> = T Function(dynamic body) -
The body deserializer which will be used to parse
the response body to the specified
Tclass.
Exceptions / Errors
- FilmGyaanException
- An exception thrown by the Filmy Gyaan SDK.
- ForbiddenException
- An exception thrown when a feature is not available for particular user.
- InvalidArgumentsException
- An exception thrown when some argument is invalid.
- InvariantException
- Exception thrown when one of the invariants of a method is broken.
- MethodDisabledException
- An exception thrown when a disabled API has been requested.
- RequestCancelException
- When the request was canceled due to some error.
- RequestFailureException
- When unable to complete the request
- RequestOtherException
- When some other exception has occurred which is unknown.
- RequestTimeoutException
- When the request timeout exception has occurred
- UnknownException
- An exception thrown when something unexpected happens in the SDK.