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

#include <requesttypes.h>

Public Member Functions

const QString & searchTerm () const
 The search term to filter on.

 
void setSearchTerm (QString newSearchTerm)
 
const QStringList & excludeItemTypes () const
 If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
 
void setExcludeItemTypes (QStringList newExcludeItemTypes)
 
bool excludeItemTypesNull () const
 
void setExcludeItemTypesNull ()
 
const bool & includeArtists () const
 Optional filter whether to include artists.

 
void setIncludeArtists (bool newIncludeArtists)
 
bool includeArtistsNull () const
 
void setIncludeArtistsNull ()
 
const bool & includeGenres () const
 Optional filter whether to include genres.

 
void setIncludeGenres (bool newIncludeGenres)
 
bool includeGenresNull () const
 
void setIncludeGenresNull ()
 
const QStringList & includeItemTypes () const
 If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.

 
void setIncludeItemTypes (QStringList newIncludeItemTypes)
 
bool includeItemTypesNull () const
 
void setIncludeItemTypesNull ()
 
const bool & includeMedia () const
 Optional filter whether to include media.

 
void setIncludeMedia (bool newIncludeMedia)
 
bool includeMediaNull () const
 
void setIncludeMediaNull ()
 
const bool & includePeople () const
 Optional filter whether to include people.

 
void setIncludePeople (bool newIncludePeople)
 
bool includePeopleNull () const
 
void setIncludePeopleNull ()
 
const bool & includeStudios () const
 Optional filter whether to include studios.

 
void setIncludeStudios (bool newIncludeStudios)
 
bool includeStudiosNull () const
 
void setIncludeStudiosNull ()
 
const bool & isKids () const
 Optional filter for kids.

 
void setIsKids (bool newIsKids)
 
bool isKidsNull () const
 
void setIsKidsNull ()
 
const bool & isMovie () const
 Optional filter for movies.

 
void setIsMovie (bool newIsMovie)
 
bool isMovieNull () const
 
void setIsMovieNull ()
 
const bool & isNews () const
 Optional filter for news.

 
void setIsNews (bool newIsNews)
 
bool isNewsNull () const
 
void setIsNewsNull ()
 
const bool & isSeries () const
 Optional filter for series.

 
void setIsSeries (bool newIsSeries)
 
bool isSeriesNull () const
 
void setIsSeriesNull ()
 
const bool & isSports () const
 Optional filter for sports.

 
void setIsSports (bool newIsSports)
 
bool isSportsNull () const
 
void setIsSportsNull ()
 
const qint32 & limit () const
 Optional. The maximum number of records to return.

 
void setLimit (qint32 newLimit)
 
bool limitNull () const
 
void setLimitNull ()
 
const QStringList & mediaTypes () const
 If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.

 
void setMediaTypes (QStringList newMediaTypes)
 
bool mediaTypesNull () const
 
void setMediaTypesNull ()
 
const QString & parentId () const
 If specified, only children of the parent are returned.

 
void setParentId (QString newParentId)
 
bool parentIdNull () const
 
void setParentIdNull ()
 
const qint32 & startIndex () const
 Optional. The record index to start at. All items with a lower index will be dropped from the results.

 
void setStartIndex (qint32 newStartIndex)
 
bool startIndexNull () const
 
void setStartIndexNull ()
 
const QString & userId () const
 Optional. Supply a user id to search within a user's library or omit to search all.

 
void setUserId (QString newUserId)
 
bool userIdNull () const
 
void setUserIdNull ()
 

Member Function Documentation

◆ excludeItemTypes()

const QStringList & Jellyfin::Loader::GetParams::excludeItemTypes ( ) const

If specified, results with these item types are filtered out. This allows multiple, comma delimeted.

◆ excludeItemTypesNull()

bool Jellyfin::Loader::GetParams::excludeItemTypesNull ( ) const

◆ includeArtists()

const bool & Jellyfin::Loader::GetParams::includeArtists ( ) const

Optional filter whether to include artists.

◆ includeArtistsNull()

bool Jellyfin::Loader::GetParams::includeArtistsNull ( ) const

◆ includeGenres()

const bool & Jellyfin::Loader::GetParams::includeGenres ( ) const

Optional filter whether to include genres.

◆ includeGenresNull()

bool Jellyfin::Loader::GetParams::includeGenresNull ( ) const

◆ includeItemTypes()

const QStringList & Jellyfin::Loader::GetParams::includeItemTypes ( ) const

If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.

◆ includeItemTypesNull()

bool Jellyfin::Loader::GetParams::includeItemTypesNull ( ) const

◆ includeMedia()

const bool & Jellyfin::Loader::GetParams::includeMedia ( ) const

Optional filter whether to include media.

◆ includeMediaNull()

bool Jellyfin::Loader::GetParams::includeMediaNull ( ) const

◆ includePeople()

const bool & Jellyfin::Loader::GetParams::includePeople ( ) const

Optional filter whether to include people.

◆ includePeopleNull()

bool Jellyfin::Loader::GetParams::includePeopleNull ( ) const

◆ includeStudios()

const bool & Jellyfin::Loader::GetParams::includeStudios ( ) const

Optional filter whether to include studios.

◆ includeStudiosNull()

bool Jellyfin::Loader::GetParams::includeStudiosNull ( ) const

◆ isKids()

const bool & Jellyfin::Loader::GetParams::isKids ( ) const

Optional filter for kids.

◆ isKidsNull()

bool Jellyfin::Loader::GetParams::isKidsNull ( ) const

◆ isMovie()

const bool & Jellyfin::Loader::GetParams::isMovie ( ) const

Optional filter for movies.

◆ isMovieNull()

bool Jellyfin::Loader::GetParams::isMovieNull ( ) const

◆ isNews()

const bool & Jellyfin::Loader::GetParams::isNews ( ) const

Optional filter for news.

◆ isNewsNull()

bool Jellyfin::Loader::GetParams::isNewsNull ( ) const

◆ isSeries()

const bool & Jellyfin::Loader::GetParams::isSeries ( ) const

Optional filter for series.

◆ isSeriesNull()

bool Jellyfin::Loader::GetParams::isSeriesNull ( ) const

◆ isSports()

const bool & Jellyfin::Loader::GetParams::isSports ( ) const

Optional filter for sports.

◆ isSportsNull()

bool Jellyfin::Loader::GetParams::isSportsNull ( ) const

◆ limit()

const qint32 & Jellyfin::Loader::GetParams::limit ( ) const

Optional. The maximum number of records to return.

◆ limitNull()

bool Jellyfin::Loader::GetParams::limitNull ( ) const

◆ mediaTypes()

const QStringList & Jellyfin::Loader::GetParams::mediaTypes ( ) const

If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.

◆ mediaTypesNull()

bool Jellyfin::Loader::GetParams::mediaTypesNull ( ) const

◆ parentId()

const QString & Jellyfin::Loader::GetParams::parentId ( ) const

If specified, only children of the parent are returned.

◆ parentIdNull()

bool Jellyfin::Loader::GetParams::parentIdNull ( ) const

◆ searchTerm()

const QString & Jellyfin::Loader::GetParams::searchTerm ( ) const

The search term to filter on.

◆ setExcludeItemTypes()

void Jellyfin::Loader::GetParams::setExcludeItemTypes ( QStringList newExcludeItemTypes)

◆ setExcludeItemTypesNull()

void Jellyfin::Loader::GetParams::setExcludeItemTypesNull ( )

◆ setIncludeArtists()

void Jellyfin::Loader::GetParams::setIncludeArtists ( bool newIncludeArtists)

◆ setIncludeArtistsNull()

void Jellyfin::Loader::GetParams::setIncludeArtistsNull ( )

◆ setIncludeGenres()

void Jellyfin::Loader::GetParams::setIncludeGenres ( bool newIncludeGenres)

◆ setIncludeGenresNull()

void Jellyfin::Loader::GetParams::setIncludeGenresNull ( )

◆ setIncludeItemTypes()

void Jellyfin::Loader::GetParams::setIncludeItemTypes ( QStringList newIncludeItemTypes)

◆ setIncludeItemTypesNull()

void Jellyfin::Loader::GetParams::setIncludeItemTypesNull ( )

◆ setIncludeMedia()

void Jellyfin::Loader::GetParams::setIncludeMedia ( bool newIncludeMedia)

◆ setIncludeMediaNull()

void Jellyfin::Loader::GetParams::setIncludeMediaNull ( )

◆ setIncludePeople()

void Jellyfin::Loader::GetParams::setIncludePeople ( bool newIncludePeople)

◆ setIncludePeopleNull()

void Jellyfin::Loader::GetParams::setIncludePeopleNull ( )

◆ setIncludeStudios()

void Jellyfin::Loader::GetParams::setIncludeStudios ( bool newIncludeStudios)

◆ setIncludeStudiosNull()

void Jellyfin::Loader::GetParams::setIncludeStudiosNull ( )

◆ setIsKids()

void Jellyfin::Loader::GetParams::setIsKids ( bool newIsKids)

◆ setIsKidsNull()

void Jellyfin::Loader::GetParams::setIsKidsNull ( )

◆ setIsMovie()

void Jellyfin::Loader::GetParams::setIsMovie ( bool newIsMovie)

◆ setIsMovieNull()

void Jellyfin::Loader::GetParams::setIsMovieNull ( )

◆ setIsNews()

void Jellyfin::Loader::GetParams::setIsNews ( bool newIsNews)

◆ setIsNewsNull()

void Jellyfin::Loader::GetParams::setIsNewsNull ( )

◆ setIsSeries()

void Jellyfin::Loader::GetParams::setIsSeries ( bool newIsSeries)

◆ setIsSeriesNull()

void Jellyfin::Loader::GetParams::setIsSeriesNull ( )

◆ setIsSports()

void Jellyfin::Loader::GetParams::setIsSports ( bool newIsSports)

◆ setIsSportsNull()

void Jellyfin::Loader::GetParams::setIsSportsNull ( )

◆ setLimit()

void Jellyfin::Loader::GetParams::setLimit ( qint32 newLimit)

◆ setLimitNull()

void Jellyfin::Loader::GetParams::setLimitNull ( )

◆ setMediaTypes()

void Jellyfin::Loader::GetParams::setMediaTypes ( QStringList newMediaTypes)

◆ setMediaTypesNull()

void Jellyfin::Loader::GetParams::setMediaTypesNull ( )

◆ setParentId()

void Jellyfin::Loader::GetParams::setParentId ( QString newParentId)

◆ setParentIdNull()

void Jellyfin::Loader::GetParams::setParentIdNull ( )

◆ setSearchTerm()

void Jellyfin::Loader::GetParams::setSearchTerm ( QString newSearchTerm)

◆ setStartIndex()

void Jellyfin::Loader::GetParams::setStartIndex ( qint32 newStartIndex)

◆ setStartIndexNull()

void Jellyfin::Loader::GetParams::setStartIndexNull ( )

◆ setUserId()

void Jellyfin::Loader::GetParams::setUserId ( QString newUserId)

◆ setUserIdNull()

void Jellyfin::Loader::GetParams::setUserIdNull ( )

◆ startIndex()

const qint32 & Jellyfin::Loader::GetParams::startIndex ( ) const

Optional. The record index to start at. All items with a lower index will be dropped from the results.

◆ startIndexNull()

bool Jellyfin::Loader::GetParams::startIndexNull ( ) const

◆ userId()

const QString & Jellyfin::Loader::GetParams::userId ( ) const

Optional. Supply a user id to search within a user's library or omit to search all.

◆ userIdNull()

bool Jellyfin::Loader::GetParams::userIdNull ( ) const

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