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

Gets the search hint result. More...

#include <search.h>

Inheritance diagram for Jellyfin::Loader::HTTP::GetSearchHintsLoader:
Jellyfin::Support::HttpLoader< SearchHintResult, GetSearchHintsParams > Jellyfin::Support::HttpLoaderBase< SearchHintResult, GetSearchHintsParams > Jellyfin::Support::Loader< SearchHintResult, GetSearchHintsParams > Jellyfin::Support::LoaderBase

Public Member Functions

 GetSearchHintsLoader (ApiClient *apiClient=nullptr)
Public Member Functions inherited from Jellyfin::Support::HttpLoader< SearchHintResult, GetSearchHintsParams >
 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, GetSearchHintsParams >
 HttpLoaderBase (Jellyfin::ApiClient *apiClient)
Loader< SearchHintResult, GetSearchHintsParams >::ResultType parseResponse (int, QByteArray response)
Public Member Functions inherited from Jellyfin::Support::Loader< SearchHintResult, GetSearchHintsParams >
 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 GetSearchHintsParams &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 GetSearchHintsParams &parameters) const override
QUrlQuery query (const GetSearchHintsParams &parameters) const override
QByteArray body (const GetSearchHintsParams &parameters) const override
QNetworkAccessManager::Operation operation () const override
Protected Member Functions inherited from Jellyfin::Support::HttpLoader< SearchHintResult, GetSearchHintsParams >
virtual QString path (const GetSearchHintsParams &parameters) const=0
 Subclasses should override this method to return the path to this endpoint, with all path parameters inserted.
virtual QUrlQuery query (const GetSearchHintsParams &parameters) const=0
virtual QByteArray body (const GetSearchHintsParams &parameters) const=0
Protected Member Functions inherited from Jellyfin::Support::Loader< SearchHintResult, GetSearchHintsParams >
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, GetSearchHintsParams >
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, GetSearchHintsParams >
static SearchHintResult createDummyResponse ()
Protected Attributes inherited from Jellyfin::Support::Loader< SearchHintResult, GetSearchHintsParams >
std::optional< GetSearchHintsParams > 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

◆ GetSearchHintsLoader()

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

Member Function Documentation

◆ body()

QByteArray Jellyfin::Loader::HTTP::GetSearchHintsLoader::body ( const GetSearchHintsParams & parameters) const
overrideprotected

◆ operation()

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

◆ path()

QString Jellyfin::Loader::HTTP::GetSearchHintsLoader::path ( const GetSearchHintsParams & parameters) const
overrideprotected

◆ query()

QUrlQuery Jellyfin::Loader::HTTP::GetSearchHintsLoader::query ( const GetSearchHintsParams & parameters) const
overrideprotected

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