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

#include <requesttypes.h>

Public Member Functions

const QString & searchTerm () const
 The search term to filter on.
void setSearchTerm (QString newSearchTerm)
const QList< BaseItemKind > & excludeItemTypes () const
 If specified, results with these item types are filtered out. This allows multiple, comma delimited.
void setExcludeItemTypes (QList< BaseItemKind > 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 QList< BaseItemKind > & includeItemTypes () const
 If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
void setIncludeItemTypes (QList< BaseItemKind > 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 QList< MediaType > & mediaTypes () const
 If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
void setMediaTypes (QList< MediaType > 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 QList< BaseItemKind > & Jellyfin::Loader::GetSearchHintsParams::excludeItemTypes ( ) const

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

◆ excludeItemTypesNull()

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

◆ includeArtists()

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

Optional filter whether to include artists.

◆ includeArtistsNull()

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

◆ includeGenres()

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

Optional filter whether to include genres.

◆ includeGenresNull()

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

◆ includeItemTypes()

const QList< BaseItemKind > & Jellyfin::Loader::GetSearchHintsParams::includeItemTypes ( ) const

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

◆ includeItemTypesNull()

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

◆ includeMedia()

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

Optional filter whether to include media.

◆ includeMediaNull()

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

◆ includePeople()

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

Optional filter whether to include people.

◆ includePeopleNull()

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

◆ includeStudios()

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

Optional filter whether to include studios.

◆ includeStudiosNull()

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

◆ isKids()

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

Optional filter for kids.

◆ isKidsNull()

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

◆ isMovie()

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

Optional filter for movies.

◆ isMovieNull()

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

◆ isNews()

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

Optional filter for news.

◆ isNewsNull()

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

◆ isSeries()

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

Optional filter for series.

◆ isSeriesNull()

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

◆ isSports()

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

Optional filter for sports.

◆ isSportsNull()

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

◆ limit()

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

Optional. The maximum number of records to return.

◆ limitNull()

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

◆ mediaTypes()

const QList< MediaType > & Jellyfin::Loader::GetSearchHintsParams::mediaTypes ( ) const

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

◆ mediaTypesNull()

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

◆ parentId()

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

If specified, only children of the parent are returned.

◆ parentIdNull()

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

◆ searchTerm()

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

The search term to filter on.

◆ setExcludeItemTypes()

void Jellyfin::Loader::GetSearchHintsParams::setExcludeItemTypes ( QList< BaseItemKind > newExcludeItemTypes)

◆ setExcludeItemTypesNull()

void Jellyfin::Loader::GetSearchHintsParams::setExcludeItemTypesNull ( )

◆ setIncludeArtists()

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

◆ setIncludeArtistsNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeArtistsNull ( )

◆ setIncludeGenres()

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

◆ setIncludeGenresNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeGenresNull ( )

◆ setIncludeItemTypes()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeItemTypes ( QList< BaseItemKind > newIncludeItemTypes)

◆ setIncludeItemTypesNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeItemTypesNull ( )

◆ setIncludeMedia()

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

◆ setIncludeMediaNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeMediaNull ( )

◆ setIncludePeople()

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

◆ setIncludePeopleNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludePeopleNull ( )

◆ setIncludeStudios()

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

◆ setIncludeStudiosNull()

void Jellyfin::Loader::GetSearchHintsParams::setIncludeStudiosNull ( )

◆ setIsKids()

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

◆ setIsKidsNull()

void Jellyfin::Loader::GetSearchHintsParams::setIsKidsNull ( )

◆ setIsMovie()

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

◆ setIsMovieNull()

void Jellyfin::Loader::GetSearchHintsParams::setIsMovieNull ( )

◆ setIsNews()

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

◆ setIsNewsNull()

void Jellyfin::Loader::GetSearchHintsParams::setIsNewsNull ( )

◆ setIsSeries()

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

◆ setIsSeriesNull()

void Jellyfin::Loader::GetSearchHintsParams::setIsSeriesNull ( )

◆ setIsSports()

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

◆ setIsSportsNull()

void Jellyfin::Loader::GetSearchHintsParams::setIsSportsNull ( )

◆ setLimit()

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

◆ setLimitNull()

void Jellyfin::Loader::GetSearchHintsParams::setLimitNull ( )

◆ setMediaTypes()

void Jellyfin::Loader::GetSearchHintsParams::setMediaTypes ( QList< MediaType > newMediaTypes)

◆ setMediaTypesNull()

void Jellyfin::Loader::GetSearchHintsParams::setMediaTypesNull ( )

◆ setParentId()

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

◆ setParentIdNull()

void Jellyfin::Loader::GetSearchHintsParams::setParentIdNull ( )

◆ setSearchTerm()

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

◆ setStartIndex()

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

◆ setStartIndexNull()

void Jellyfin::Loader::GetSearchHintsParams::setStartIndexNull ( )

◆ setUserId()

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

◆ setUserIdNull()

void Jellyfin::Loader::GetSearchHintsParams::setUserIdNull ( )

◆ startIndex()

const qint32 & Jellyfin::Loader::GetSearchHintsParams::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::GetSearchHintsParams::startIndexNull ( ) const

◆ userId()

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

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

◆ userIdNull()

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

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