Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::Loader::HTTP::GetLoader Class Reference

Gets the search hint result. More...

#include <search.h>

Inheritance diagram for Jellyfin::Loader::HTTP::GetLoader:
Jellyfin::Support::HttpLoader< SearchHintResult, GetParams > Jellyfin::Support::HttpLoaderBase< SearchHintResult, GetParams > Jellyfin::Support::Loader< SearchHintResult, GetParams > Jellyfin::Support::LoaderBase

Public Member Functions

 GetLoader (ApiClient *apiClient=nullptr)
 
- Public Member Functions inherited from Jellyfin::Support::HttpLoader< SearchHintResult, GetParams >
 HttpLoader (Jellyfin::ApiClient *apiClient)
 
virtual void load () override
 load Loads the given resource asynchronously.
 
virtual void cancel () override
 
bool isAvailable () const override
 Heuristic to determine if this resource can be loaded via this loaded.
 
- Public Member Functions inherited from Jellyfin::Support::HttpLoaderBase< SearchHintResult, GetParams >
 HttpLoaderBase (Jellyfin::ApiClient *apiClient)
 
Loader< SearchHintResult, GetParams >::ResultType parseResponse (int, QByteArray response)
 
- Public Member Functions inherited from Jellyfin::Support::Loader< SearchHintResult, GetParams >
 Loader (ApiClient *apiClient)
 
SearchHintResult result () const
 Retrieves the loaded resource. Only valid after the ready signal has been emitted.
 
bool hasResult () const
 
void setParameters (const GetParams &parameters)
 Sets the parameters for this loader.
 
- Public Member Functions inherited from Jellyfin::Support::LoaderBase
bool isRunning () const
 
void setApiClient (ApiClient *newApiClient)
 
ApiClientapiClient () const
 

Protected Member Functions

QString path (const GetParams &parameters) const override
 
QUrlQuery query (const GetParams &parameters) const override
 
QByteArray body (const GetParams &parameters) const override
 
QNetworkAccessManager::Operation operation () const override
 
- Protected Member Functions inherited from Jellyfin::Support::HttpLoader< SearchHintResult, GetParams >
virtual QString path (const GetParams &parameters) const=0
 Subclasses should override this method to return the path to this endpoint, with all path parameters inserted.
 
virtual QUrlQuery query (const GetParams &parameters) const=0
 
virtual QByteArray body (const GetParams &parameters) const=0
 
- Protected Member Functions inherited from Jellyfin::Support::Loader< SearchHintResult, GetParams >
ResultType createFailureResult ()
 
ResultType createSuccessResult (SearchHintResult &&result)
 
- Protected Member Functions inherited from Jellyfin::Support::LoaderBase
 LoaderBase (ApiClient *apiClient)
 
void stopWithError (QString message=QString())
 

Additional Inherited Members

- Public Types inherited from Jellyfin::Support::Loader< SearchHintResult, GetParams >
using ResultType
 
- 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.
 
- Static Protected Member Functions inherited from Jellyfin::Support::Loader< SearchHintResult, GetParams >
static SearchHintResult createDummyResponse ()
 
- Protected Attributes inherited from Jellyfin::Support::Loader< SearchHintResult, GetParams >
std::optional< GetParams > m_parameters
 
ResultType m_result
 
- Protected Attributes inherited from Jellyfin::Support::LoaderBase
Jellyfin::ApiClientm_apiClient
 
bool m_isRunning = false
 

Detailed Description

Gets the search hint result.

Constructor & Destructor Documentation

◆ GetLoader()

Jellyfin::Loader::HTTP::GetLoader::GetLoader ( ApiClient * apiClient = nullptr)
explicit

Member Function Documentation

◆ body()

QByteArray Jellyfin::Loader::HTTP::GetLoader::body ( const GetParams & parameters) const
overrideprotected

◆ operation()

QNetworkAccessManager::Operation Jellyfin::Loader::HTTP::GetLoader::operation ( ) const
overrideprotectedvirtual

◆ path()

QString Jellyfin::Loader::HTTP::GetLoader::path ( const GetParams & parameters) const
overrideprotected

◆ query()

QUrlQuery Jellyfin::Loader::HTTP::GetLoader::query ( const GetParams & parameters) const
overrideprotected

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