Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::ViewModel::UserLoader Class Reference

#include <user.h>

Inheritance diagram for Jellyfin::ViewModel::UserLoader:
Jellyfin::ViewModel::Loader< ViewModel::User, DTO::UserDto, Jellyfin::Loader::GetUserByIdParams > Jellyfin::ViewModel::LoaderBase

Signals

void userIdChanged (const QString &newUserId) const
Signals inherited from Jellyfin::ViewModel::LoaderBase
void statusChanged (Jellyfin::ViewModel::LoaderBase::Status newStatus)
void apiClientChanged (ApiClient *newApiClient)
void errorStringChanged (QString newErrorString)
void autoReloadChanged (bool newAutoReload)
void dataChanged ()
void ready ()
 Convenience signal for status == RemoteData.Ready.

Public Member Functions

 UserLoader (QObject *parent=nullptr)
QString userId () const
void setUserId (QString newUserId)
virtual bool canReload () const override
 Subclasses should implement this to determine if they can load data from the server.
Public Member Functions inherited from Jellyfin::ViewModel::Loader< ViewModel::User, DTO::UserDto, Jellyfin::Loader::GetUserByIdParams >
 Loader (Support::Loader< DTO::UserDto, Jellyfin::Loader::GetUserByIdParams > *loaderImpl, QObject *parent=nullptr)
 Loader (ApiClient *apiClient, Support::Loader< DTO::UserDto, Jellyfin::Loader::GetUserByIdParams > *loaderImpl, QObject *parent=nullptr)
ViewModel::UserdataViewModel () const
QObject * data () const override
void reload () override
 Overload this method to reimplement the fetching mechanism to populate the RemoteData with data from the server.
Public Member Functions inherited from Jellyfin::ViewModel::LoaderBase
 LoaderBase (QObject *parent=nullptr)
 LoaderBase (ApiClient *apiClient, QObject *parent=nullptr)
Status status () const
QString errorString () const
void setApiClient (ApiClient *newApiClient)
void setExtraFields (const QStringList &extraFields)

Properties

QString userId
Properties inherited from Jellyfin::ViewModel::LoaderBase
ApiClientapiClient
Jellyfin::ViewModel::LoaderBase::Status status
QString errorString
bool autoReload
QObject * data

Additional Inherited Members

Public Types inherited from Jellyfin::ViewModel::LoaderBase
enum  Status { Uninitialised , Loading , Ready , Error }
Protected Member Functions inherited from Jellyfin::ViewModel::LoaderBase
void setStatus (Status newStatus)
void setError (QNetworkReply::NetworkError error)
void setErrorString (const QString &newErrorString)
void reloadIfNeeded ()
void classBegin () override
void componentComplete () override
bool isQmlParsing () const
void emitDataChanged ()
Protected Attributes inherited from Jellyfin::ViewModel::Loader< ViewModel::User, DTO::UserDto, Jellyfin::Loader::GetUserByIdParams >
ViewModel::Userm_dataViewModel
Jellyfin::Loader::GetUserByIdParams m_parameters
QScopedPointer< Support::Loader< DTO::UserDto, Jellyfin::Loader::GetUserByIdParams > > m_loader
 Subclasses should initialize this to a loader that actually loads stuff.
Protected Attributes inherited from Jellyfin::ViewModel::LoaderBase
ApiClientm_apiClient = nullptr

Constructor & Destructor Documentation

◆ UserLoader()

Jellyfin::ViewModel::UserLoader::UserLoader ( QObject * parent = nullptr)
explicit

Member Function Documentation

◆ canReload()

bool Jellyfin::ViewModel::UserLoader::canReload ( ) const
overridevirtual

Subclasses should implement this to determine if they can load data from the server.

Usage cases include checking if the required properties, such as the item id are set.

Reimplemented from Jellyfin::ViewModel::LoaderBase.

◆ setUserId()

void Jellyfin::ViewModel::UserLoader::setUserId ( QString newUserId)

◆ userId()

QString Jellyfin::ViewModel::UserLoader::userId ( ) const
inline

◆ userIdChanged

void Jellyfin::ViewModel::UserLoader::userIdChanged ( const QString & newUserId) const
signal

Property Documentation

◆ userId

QString Jellyfin::ViewModel::UserLoader::userId
readwrite

The documentation for this class was generated from the following files:
  • core/include/JellyfinQt/viewmodel/user.h
  • core/src/viewmodel/user.cpp