Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::Support::Loader< void, P > Class Template Reference

#include <loader.h>

Inheritance diagram for Jellyfin::Support::Loader< void, P >:
Jellyfin::Support::LoaderBase Jellyfin::Support::HttpLoaderBase< void, P >

Public Types

using ResultType = bool
 

Public Member Functions

 Loader (ApiClient *apiClient)
 
void result () const
 
bool hasResult () const
 
void setParameters (const P &parameters)
 Sets the parameters for this loader.
 
- Public Member Functions inherited from Jellyfin::Support::LoaderBase
virtual void load ()
 load Loads the given resource asynchronously.
 
virtual void cancel ()
 
bool isRunning () const
 
virtual bool isAvailable () const
 Heuristic to determine if this resource can be loaded via this loaded.
 
void setApiClient (ApiClient *newApiClient)
 
ApiClientapiClient () const
 

Protected Member Functions

ResultType createFailureResult ()
 
ResultType createSuccessResult (void)
 
- Protected Member Functions inherited from Jellyfin::Support::LoaderBase
 LoaderBase (ApiClient *apiClient)
 
void stopWithError (QString message=QString())
 

Static Protected Member Functions

static void createDummyResponse ()
 

Protected Attributes

std::optional< P > m_parameters
 
ResultType m_result
 
- Protected Attributes inherited from Jellyfin::Support::LoaderBase
Jellyfin::ApiClientm_apiClient
 
bool m_isRunning = false
 

Additional Inherited Members

- Signals inherited from Jellyfin::Support::LoaderBase
void error (QString message=QString())
 Emitted when an error has occurred during loading and no result is available.
 
void ready ()
 Emitted when data was successfully loaded.
 

Member Typedef Documentation

◆ ResultType

template<typename P >
using Jellyfin::Support::Loader< void, P >::ResultType = bool

Constructor & Destructor Documentation

◆ Loader()

template<typename P >
Jellyfin::Support::Loader< void, P >::Loader ( ApiClient * apiClient)
inlineexplicit

Member Function Documentation

◆ createDummyResponse()

template<typename P >
static void Jellyfin::Support::Loader< void, P >::createDummyResponse ( )
inlinestaticprotected

◆ createFailureResult()

template<typename P >
ResultType Jellyfin::Support::Loader< void, P >::createFailureResult ( )
inlineprotected

◆ createSuccessResult()

template<typename P >
ResultType Jellyfin::Support::Loader< void, P >::createSuccessResult ( void )
inlineprotected

◆ hasResult()

template<typename P >
bool Jellyfin::Support::Loader< void, P >::hasResult ( ) const
inline

◆ result()

template<typename P >
void Jellyfin::Support::Loader< void, P >::result ( ) const
inline

◆ setParameters()

template<typename P >
void Jellyfin::Support::Loader< void, P >::setParameters ( const P & parameters)
inline

Sets the parameters for this loader.

Parameters
parametersThe parameters to set

This method will copy the parameters. The parameters must have a copy constructor.

Member Data Documentation

◆ m_parameters

template<typename P >
std::optional<P> Jellyfin::Support::Loader< void, P >::m_parameters
protected

◆ m_result

template<typename P >
ResultType Jellyfin::Support::Loader< void, P >::m_result
protected

The documentation for this class was generated from the following file: