Jellyfin::Loader::GetArtistsParams Class Reference

#include <requesttypes.h>

Public Member Functions
const QList< ImageType > &	enableImageTypes () const
	Optional. The image types to include in the output.
void	setEnableImageTypes (QList< ImageType > newEnableImageTypes)
bool	enableImageTypesNull () const
void	setEnableImageTypesNull ()
const bool &	enableImages () const
	Optional, include image information in output.
void	setEnableImages (bool newEnableImages)
bool	enableImagesNull () const
void	setEnableImagesNull ()
const bool &	enableTotalRecordCount () const
	Total record count.
void	setEnableTotalRecordCount (bool newEnableTotalRecordCount)
bool	enableTotalRecordCountNull () const
void	setEnableTotalRecordCountNull ()
const bool &	enableUserData () const
	Optional, include user data.
void	setEnableUserData (bool newEnableUserData)
bool	enableUserDataNull () const
void	setEnableUserDataNull ()
const QStringList &	excludeItemTypes () const
	Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
void	setExcludeItemTypes (QStringList newExcludeItemTypes)
bool	excludeItemTypesNull () const
void	setExcludeItemTypesNull ()
const QList< ItemFields > &	fields () const
	Optional. Specify additional fields of information to return in the output.
void	setFields (QList< ItemFields > newFields)
bool	fieldsNull () const
void	setFieldsNull ()
const QList< ItemFilter > &	filters () const
	Optional. Specify additional filters to apply.
void	setFilters (QList< ItemFilter > newFilters)
bool	filtersNull () const
void	setFiltersNull ()
const QStringList &	genreIds () const
	Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
void	setGenreIds (QStringList newGenreIds)
bool	genreIdsNull () const
void	setGenreIdsNull ()
const QStringList &	genres () const
	Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
void	setGenres (QStringList newGenres)
bool	genresNull () const
void	setGenresNull ()
const qint32 &	imageTypeLimit () const
	Optional, the max number of images to return, per image type.
void	setImageTypeLimit (qint32 newImageTypeLimit)
bool	imageTypeLimitNull () const
void	setImageTypeLimitNull ()
const QStringList &	includeItemTypes () const
	Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
void	setIncludeItemTypes (QStringList newIncludeItemTypes)
bool	includeItemTypesNull () const
void	setIncludeItemTypesNull ()
const bool &	isFavorite () const
	Optional filter by items that are marked as favorite, or not.
void	setIsFavorite (bool newIsFavorite)
bool	isFavoriteNull () const
void	setIsFavoriteNull ()
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
	Optional filter by MediaType. Allows multiple, comma delimited.
void	setMediaTypes (QStringList newMediaTypes)
bool	mediaTypesNull () const
void	setMediaTypesNull ()
const double &	minCommunityRating () const
	Optional filter by minimum community rating.
void	setMinCommunityRating (double newMinCommunityRating)
bool	minCommunityRatingNull () const
void	setMinCommunityRatingNull ()
const QString &	nameLessThan () const
	Optional filter by items whose name is equally or lesser than a given input string.
void	setNameLessThan (QString newNameLessThan)
bool	nameLessThanNull () const
void	setNameLessThanNull ()
const QString &	nameStartsWith () const
	Optional filter by items whose name is sorted equally than a given input string.
void	setNameStartsWith (QString newNameStartsWith)
bool	nameStartsWithNull () const
void	setNameStartsWithNull ()
const QString &	nameStartsWithOrGreater () const
	Optional filter by items whose name is sorted equally or greater than a given input string.
void	setNameStartsWithOrGreater (QString newNameStartsWithOrGreater)
bool	nameStartsWithOrGreaterNull () const
void	setNameStartsWithOrGreaterNull ()
const QStringList &	officialRatings () const
	Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
void	setOfficialRatings (QStringList newOfficialRatings)
bool	officialRatingsNull () const
void	setOfficialRatingsNull ()
const QString &	parentId () const
	Specify this to localize the search to a specific item or folder. Omit to use the root.
void	setParentId (QString newParentId)
bool	parentIdNull () const
void	setParentIdNull ()
const QString &	person () const
	Optional. If specified, results will be filtered to include only those containing the specified person.
void	setPerson (QString newPerson)
bool	personNull () const
void	setPersonNull ()
const QStringList &	personIds () const
	Optional. If specified, results will be filtered to include only those containing the specified person ids.
void	setPersonIds (QStringList newPersonIds)
bool	personIdsNull () const
void	setPersonIdsNull ()
const QStringList &	personTypes () const
	Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
void	setPersonTypes (QStringList newPersonTypes)
bool	personTypesNull () const
void	setPersonTypesNull ()
const QString &	searchTerm () const
	Optional. Search term.
void	setSearchTerm (QString newSearchTerm)
bool	searchTermNull () const
void	setSearchTermNull ()
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 QStringList &	studioIds () const
	Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
void	setStudioIds (QStringList newStudioIds)
bool	studioIdsNull () const
void	setStudioIdsNull ()
const QStringList &	studios () const
	Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
void	setStudios (QStringList newStudios)
bool	studiosNull () const
void	setStudiosNull ()
const QStringList &	tags () const
	Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
void	setTags (QStringList newTags)
bool	tagsNull () const
void	setTagsNull ()
const QString &	userId () const
	User id.
void	setUserId (QString newUserId)
bool	userIdNull () const
void	setUserIdNull ()
const QList< qint32 > &	years () const
	Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
void	setYears (QList< qint32 > newYears)
bool	yearsNull () const
void	setYearsNull ()

Member Function Documentation

enableImages()

const bool & Jellyfin::Loader::GetArtistsParams::enableImages

(

)

const

Optional, include image information in output.

enableImagesNull()

bool Jellyfin::Loader::GetArtistsParams::enableImagesNull

(

)

const

enableImageTypes()

const QList< ImageType > & Jellyfin::Loader::GetArtistsParams::enableImageTypes

(

)

const

Optional. The image types to include in the output.

enableImageTypesNull()

bool Jellyfin::Loader::GetArtistsParams::enableImageTypesNull

(

)

const

enableTotalRecordCount()

const bool & Jellyfin::Loader::GetArtistsParams::enableTotalRecordCount

(

)

const

Total record count.

enableTotalRecordCountNull()

bool Jellyfin::Loader::GetArtistsParams::enableTotalRecordCountNull

(

)

const

enableUserData()

const bool & Jellyfin::Loader::GetArtistsParams::enableUserData

(

)

const

Optional, include user data.

enableUserDataNull()

bool Jellyfin::Loader::GetArtistsParams::enableUserDataNull

(

)

const

excludeItemTypes()

const QStringList & Jellyfin::Loader::GetArtistsParams::excludeItemTypes

(

)

const

Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

excludeItemTypesNull()

bool Jellyfin::Loader::GetArtistsParams::excludeItemTypesNull

(

)

const

fields()

const QList< ItemFields > & Jellyfin::Loader::GetArtistsParams::fields

(

)

const

Optional. Specify additional fields of information to return in the output.

fieldsNull()

bool Jellyfin::Loader::GetArtistsParams::fieldsNull

(

)

const

filters()

const QList< ItemFilter > & Jellyfin::Loader::GetArtistsParams::filters

(

)

const

Optional. Specify additional filters to apply.

filtersNull()

bool Jellyfin::Loader::GetArtistsParams::filtersNull

(

)

const

genreIds()

const QStringList & Jellyfin::Loader::GetArtistsParams::genreIds

(

)

const

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

genreIdsNull()

bool Jellyfin::Loader::GetArtistsParams::genreIdsNull

(

)

const

genres()

const QStringList & Jellyfin::Loader::GetArtistsParams::genres

(

)

const

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

genresNull()

bool Jellyfin::Loader::GetArtistsParams::genresNull

(

)

const

imageTypeLimit()

const qint32 & Jellyfin::Loader::GetArtistsParams::imageTypeLimit

(

)

const

Optional, the max number of images to return, per image type.

imageTypeLimitNull()

bool Jellyfin::Loader::GetArtistsParams::imageTypeLimitNull

(

)

const

includeItemTypes()

const QStringList & Jellyfin::Loader::GetArtistsParams::includeItemTypes

(

)

const

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

includeItemTypesNull()

bool Jellyfin::Loader::GetArtistsParams::includeItemTypesNull

(

)

const

isFavorite()

const bool & Jellyfin::Loader::GetArtistsParams::isFavorite

(

)

const

Optional filter by items that are marked as favorite, or not.

isFavoriteNull()

bool Jellyfin::Loader::GetArtistsParams::isFavoriteNull

(

)

const

limit()

const qint32 & Jellyfin::Loader::GetArtistsParams::limit

(

)

const

Optional. The maximum number of records to return.

limitNull()

bool Jellyfin::Loader::GetArtistsParams::limitNull

(

)

const

mediaTypes()

const QStringList & Jellyfin::Loader::GetArtistsParams::mediaTypes

(

)

const

Optional filter by MediaType. Allows multiple, comma delimited.

mediaTypesNull()

bool Jellyfin::Loader::GetArtistsParams::mediaTypesNull

(

)

const

minCommunityRating()

const double & Jellyfin::Loader::GetArtistsParams::minCommunityRating

(

)

const

Optional filter by minimum community rating.

minCommunityRatingNull()

bool Jellyfin::Loader::GetArtistsParams::minCommunityRatingNull

(

)

const

nameLessThan()

const QString & Jellyfin::Loader::GetArtistsParams::nameLessThan

(

)

const

Optional filter by items whose name is equally or lesser than a given input string.

nameLessThanNull()

bool Jellyfin::Loader::GetArtistsParams::nameLessThanNull

(

)

const

nameStartsWith()

const QString & Jellyfin::Loader::GetArtistsParams::nameStartsWith

(

)

const

Optional filter by items whose name is sorted equally than a given input string.

nameStartsWithNull()

bool Jellyfin::Loader::GetArtistsParams::nameStartsWithNull

(

)

const

nameStartsWithOrGreater()

const QString & Jellyfin::Loader::GetArtistsParams::nameStartsWithOrGreater

(

)

const

Optional filter by items whose name is sorted equally or greater than a given input string.

nameStartsWithOrGreaterNull()

bool Jellyfin::Loader::GetArtistsParams::nameStartsWithOrGreaterNull

(

)

const

officialRatings()

const QStringList & Jellyfin::Loader::GetArtistsParams::officialRatings

(

)

const

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

officialRatingsNull()

bool Jellyfin::Loader::GetArtistsParams::officialRatingsNull

(

)

const

parentId()

const QString & Jellyfin::Loader::GetArtistsParams::parentId

(

)

const

Specify this to localize the search to a specific item or folder. Omit to use the root.

parentIdNull()

bool Jellyfin::Loader::GetArtistsParams::parentIdNull

(

)

const

person()

const QString & Jellyfin::Loader::GetArtistsParams::person

(

)

const

Optional. If specified, results will be filtered to include only those containing the specified person.

personIds()

const QStringList & Jellyfin::Loader::GetArtistsParams::personIds

(

)

const

Optional. If specified, results will be filtered to include only those containing the specified person ids.

personIdsNull()

bool Jellyfin::Loader::GetArtistsParams::personIdsNull

(

)

const

personNull()

bool Jellyfin::Loader::GetArtistsParams::personNull

(

)

const

personTypes()

const QStringList & Jellyfin::Loader::GetArtistsParams::personTypes

(

)

const

Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

personTypesNull()

bool Jellyfin::Loader::GetArtistsParams::personTypesNull

(

)

const

searchTerm()

const QString & Jellyfin::Loader::GetArtistsParams::searchTerm

(

)

const

Optional. Search term.

searchTermNull()

bool Jellyfin::Loader::GetArtistsParams::searchTermNull

(

)

const

setEnableImages()

void Jellyfin::Loader::GetArtistsParams::setEnableImages

(

bool

newEnableImages

)

setEnableImagesNull()

void Jellyfin::Loader::GetArtistsParams::setEnableImagesNull

(

)

setEnableImageTypes()

void Jellyfin::Loader::GetArtistsParams::setEnableImageTypes

(

QList< ImageType >

newEnableImageTypes

)

setEnableImageTypesNull()

void Jellyfin::Loader::GetArtistsParams::setEnableImageTypesNull

(

)

setEnableTotalRecordCount()

void Jellyfin::Loader::GetArtistsParams::setEnableTotalRecordCount

(

bool

newEnableTotalRecordCount

)

setEnableTotalRecordCountNull()

void Jellyfin::Loader::GetArtistsParams::setEnableTotalRecordCountNull

(

)

setEnableUserData()

void Jellyfin::Loader::GetArtistsParams::setEnableUserData

(

bool

newEnableUserData

)

setEnableUserDataNull()

void Jellyfin::Loader::GetArtistsParams::setEnableUserDataNull

(

)

setExcludeItemTypes()

void Jellyfin::Loader::GetArtistsParams::setExcludeItemTypes

(

QStringList

newExcludeItemTypes

)

setExcludeItemTypesNull()

void Jellyfin::Loader::GetArtistsParams::setExcludeItemTypesNull

(

)

setFields()

void Jellyfin::Loader::GetArtistsParams::setFields

(

QList< ItemFields >

newFields

)

setFieldsNull()

void Jellyfin::Loader::GetArtistsParams::setFieldsNull

(

)

setFilters()

void Jellyfin::Loader::GetArtistsParams::setFilters

(

QList< ItemFilter >

newFilters

)

setFiltersNull()

void Jellyfin::Loader::GetArtistsParams::setFiltersNull

(

)

setGenreIds()

void Jellyfin::Loader::GetArtistsParams::setGenreIds

(

QStringList

newGenreIds

)

setGenreIdsNull()

void Jellyfin::Loader::GetArtistsParams::setGenreIdsNull

(

)

setGenres()

void Jellyfin::Loader::GetArtistsParams::setGenres

(

QStringList

newGenres

)

setGenresNull()

void Jellyfin::Loader::GetArtistsParams::setGenresNull

(

)

setImageTypeLimit()

void Jellyfin::Loader::GetArtistsParams::setImageTypeLimit

(

qint32

newImageTypeLimit

)

setImageTypeLimitNull()

void Jellyfin::Loader::GetArtistsParams::setImageTypeLimitNull

(

)

setIncludeItemTypes()

void Jellyfin::Loader::GetArtistsParams::setIncludeItemTypes

(

QStringList

newIncludeItemTypes

)

setIncludeItemTypesNull()

void Jellyfin::Loader::GetArtistsParams::setIncludeItemTypesNull

(

)

setIsFavorite()

void Jellyfin::Loader::GetArtistsParams::setIsFavorite

(

bool

newIsFavorite

)

setIsFavoriteNull()

void Jellyfin::Loader::GetArtistsParams::setIsFavoriteNull

(

)

setLimit()

void Jellyfin::Loader::GetArtistsParams::setLimit

(

qint32

newLimit

)

setLimitNull()

void Jellyfin::Loader::GetArtistsParams::setLimitNull

(

)

setMediaTypes()

void Jellyfin::Loader::GetArtistsParams::setMediaTypes

(

QStringList

newMediaTypes

)

setMediaTypesNull()

void Jellyfin::Loader::GetArtistsParams::setMediaTypesNull

(

)

setMinCommunityRating()

void Jellyfin::Loader::GetArtistsParams::setMinCommunityRating

(

double

newMinCommunityRating

)

setMinCommunityRatingNull()

void Jellyfin::Loader::GetArtistsParams::setMinCommunityRatingNull

(

)

setNameLessThan()

void Jellyfin::Loader::GetArtistsParams::setNameLessThan

(

QString

newNameLessThan

)

setNameLessThanNull()

void Jellyfin::Loader::GetArtistsParams::setNameLessThanNull

(

)

setNameStartsWith()

void Jellyfin::Loader::GetArtistsParams::setNameStartsWith

(

QString

newNameStartsWith

)

setNameStartsWithNull()

void Jellyfin::Loader::GetArtistsParams::setNameStartsWithNull

(

)

setNameStartsWithOrGreater()

void Jellyfin::Loader::GetArtistsParams::setNameStartsWithOrGreater

(

QString

newNameStartsWithOrGreater

)

setNameStartsWithOrGreaterNull()

void Jellyfin::Loader::GetArtistsParams::setNameStartsWithOrGreaterNull

(

)

setOfficialRatings()

void Jellyfin::Loader::GetArtistsParams::setOfficialRatings

(

QStringList

newOfficialRatings

)

setOfficialRatingsNull()

void Jellyfin::Loader::GetArtistsParams::setOfficialRatingsNull

(

)

setParentId()

void Jellyfin::Loader::GetArtistsParams::setParentId

(

QString

newParentId

)

setParentIdNull()

void Jellyfin::Loader::GetArtistsParams::setParentIdNull

(

)

setPerson()

void Jellyfin::Loader::GetArtistsParams::setPerson

(

QString

newPerson

)

setPersonIds()

void Jellyfin::Loader::GetArtistsParams::setPersonIds

(

QStringList

newPersonIds

)

setPersonIdsNull()

void Jellyfin::Loader::GetArtistsParams::setPersonIdsNull

(

)

setPersonNull()

void Jellyfin::Loader::GetArtistsParams::setPersonNull

(

)

setPersonTypes()

void Jellyfin::Loader::GetArtistsParams::setPersonTypes

(

QStringList

newPersonTypes

)

setPersonTypesNull()

void Jellyfin::Loader::GetArtistsParams::setPersonTypesNull

(

)

setSearchTerm()

void Jellyfin::Loader::GetArtistsParams::setSearchTerm

(

QString

newSearchTerm

)

setSearchTermNull()

void Jellyfin::Loader::GetArtistsParams::setSearchTermNull

(

)

setStartIndex()

void Jellyfin::Loader::GetArtistsParams::setStartIndex

(

qint32

newStartIndex

)

setStartIndexNull()

void Jellyfin::Loader::GetArtistsParams::setStartIndexNull

(

)

setStudioIds()

void Jellyfin::Loader::GetArtistsParams::setStudioIds

(

QStringList

newStudioIds

)

setStudioIdsNull()

void Jellyfin::Loader::GetArtistsParams::setStudioIdsNull

(

)

setStudios()

void Jellyfin::Loader::GetArtistsParams::setStudios

(

QStringList

newStudios

)

setStudiosNull()

void Jellyfin::Loader::GetArtistsParams::setStudiosNull

(

)

setTags()

void Jellyfin::Loader::GetArtistsParams::setTags

(

QStringList

newTags

)

setTagsNull()

void Jellyfin::Loader::GetArtistsParams::setTagsNull

(

)

setUserId()

void Jellyfin::Loader::GetArtistsParams::setUserId

(

QString

newUserId

)

setUserIdNull()

void Jellyfin::Loader::GetArtistsParams::setUserIdNull

(

)

setYears()

void Jellyfin::Loader::GetArtistsParams::setYears

(

QList< qint32 >

newYears

)

setYearsNull()

void Jellyfin::Loader::GetArtistsParams::setYearsNull

(

)

startIndex()

const qint32 & Jellyfin::Loader::GetArtistsParams::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::GetArtistsParams::startIndexNull

(

)

const

studioIds()

const QStringList & Jellyfin::Loader::GetArtistsParams::studioIds

(

)

const

Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

studioIdsNull()

bool Jellyfin::Loader::GetArtistsParams::studioIdsNull

(

)

const

studios()

const QStringList & Jellyfin::Loader::GetArtistsParams::studios

(

)

const

Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

studiosNull()

bool Jellyfin::Loader::GetArtistsParams::studiosNull

(

)

const

tags()

const QStringList & Jellyfin::Loader::GetArtistsParams::tags

(

)

const

Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

tagsNull()

bool Jellyfin::Loader::GetArtistsParams::tagsNull

(

)

const

userId()

const QString & Jellyfin::Loader::GetArtistsParams::userId

(

)

const

User id.

userIdNull()

bool Jellyfin::Loader::GetArtistsParams::userIdNull

(

)

const

years()

const QList< qint32 > & Jellyfin::Loader::GetArtistsParams::years

(

)

const

Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

yearsNull()

bool Jellyfin::Loader::GetArtistsParams::yearsNull

(

)

const

---

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

• core/include/JellyfinQt/loader/requesttypes.h
• core/src/loader/requesttypes.cpp