Jellyfin::Loader::GetYearsParams 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 &	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 excluded 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 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 included based on item type. This allows multiple, comma delimited.
void	setIncludeItemTypes (QStringList newIncludeItemTypes)
bool	includeItemTypesNull () const
void	setIncludeItemTypesNull ()
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 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 bool &	recursive () const
	Search recursively.
void	setRecursive (bool newRecursive)
bool	recursiveNull () const
void	setRecursiveNull ()
const QString &	sortBy () const
	Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
void	setSortBy (QString newSortBy)
bool	sortByNull () const
void	setSortByNull ()
const QString &	sortOrder () const
	Sort Order - Ascending,Descending.
void	setSortOrder (QString newSortOrder)
bool	sortOrderNull () const
void	setSortOrderNull ()
const qint32 &	startIndex () const
	Skips over a given number of items within the results. Use for paging.
void	setStartIndex (qint32 newStartIndex)
bool	startIndexNull () const
void	setStartIndexNull ()
const QString &	userId () const
	User Id.
void	setUserId (QString newUserId)
bool	userIdNull () const
void	setUserIdNull ()

Member Function Documentation

enableImages()

const bool & Jellyfin::Loader::GetYearsParams::enableImages

(

)

const

Optional. Include image information in output.

enableImagesNull()

bool Jellyfin::Loader::GetYearsParams::enableImagesNull

(

)

const

enableImageTypes()

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

(

)

const

Optional. The image types to include in the output.

enableImageTypesNull()

bool Jellyfin::Loader::GetYearsParams::enableImageTypesNull

(

)

const

enableUserData()

const bool & Jellyfin::Loader::GetYearsParams::enableUserData

(

)

const

Optional. Include user data.

enableUserDataNull()

bool Jellyfin::Loader::GetYearsParams::enableUserDataNull

(

)

const

excludeItemTypes()

const QStringList & Jellyfin::Loader::GetYearsParams::excludeItemTypes

(

)

const

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

excludeItemTypesNull()

bool Jellyfin::Loader::GetYearsParams::excludeItemTypesNull

(

)

const

fields()

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

(

)

const

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

fieldsNull()

bool Jellyfin::Loader::GetYearsParams::fieldsNull

(

)

const

imageTypeLimit()

const qint32 & Jellyfin::Loader::GetYearsParams::imageTypeLimit

(

)

const

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

imageTypeLimitNull()

bool Jellyfin::Loader::GetYearsParams::imageTypeLimitNull

(

)

const

includeItemTypes()

const QStringList & Jellyfin::Loader::GetYearsParams::includeItemTypes

(

)

const

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

includeItemTypesNull()

bool Jellyfin::Loader::GetYearsParams::includeItemTypesNull

(

)

const

limit()

const qint32 & Jellyfin::Loader::GetYearsParams::limit

(

)

const

Optional. The maximum number of records to return.

limitNull()

bool Jellyfin::Loader::GetYearsParams::limitNull

(

)

const

mediaTypes()

const QStringList & Jellyfin::Loader::GetYearsParams::mediaTypes

(

)

const

Optional. Filter by MediaType. Allows multiple, comma delimited.

mediaTypesNull()

bool Jellyfin::Loader::GetYearsParams::mediaTypesNull

(

)

const

parentId()

const QString & Jellyfin::Loader::GetYearsParams::parentId

(

)

const

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

parentIdNull()

bool Jellyfin::Loader::GetYearsParams::parentIdNull

(

)

const

recursive()

const bool & Jellyfin::Loader::GetYearsParams::recursive

(

)

const

Search recursively.

recursiveNull()

bool Jellyfin::Loader::GetYearsParams::recursiveNull

(

)

const

setEnableImages()

void Jellyfin::Loader::GetYearsParams::setEnableImages

(

bool

newEnableImages

)

setEnableImagesNull()

void Jellyfin::Loader::GetYearsParams::setEnableImagesNull

(

)

setEnableImageTypes()

void Jellyfin::Loader::GetYearsParams::setEnableImageTypes

(

QList< ImageType >

newEnableImageTypes

)

setEnableImageTypesNull()

void Jellyfin::Loader::GetYearsParams::setEnableImageTypesNull

(

)

setEnableUserData()

void Jellyfin::Loader::GetYearsParams::setEnableUserData

(

bool

newEnableUserData

)

setEnableUserDataNull()

void Jellyfin::Loader::GetYearsParams::setEnableUserDataNull

(

)

setExcludeItemTypes()

void Jellyfin::Loader::GetYearsParams::setExcludeItemTypes

(

QStringList

newExcludeItemTypes

)

setExcludeItemTypesNull()

void Jellyfin::Loader::GetYearsParams::setExcludeItemTypesNull

(

)

setFields()

void Jellyfin::Loader::GetYearsParams::setFields

(

QList< ItemFields >

newFields

)

setFieldsNull()

void Jellyfin::Loader::GetYearsParams::setFieldsNull

(

)

setImageTypeLimit()

void Jellyfin::Loader::GetYearsParams::setImageTypeLimit

(

qint32

newImageTypeLimit

)

setImageTypeLimitNull()

void Jellyfin::Loader::GetYearsParams::setImageTypeLimitNull

(

)

setIncludeItemTypes()

void Jellyfin::Loader::GetYearsParams::setIncludeItemTypes

(

QStringList

newIncludeItemTypes

)

setIncludeItemTypesNull()

void Jellyfin::Loader::GetYearsParams::setIncludeItemTypesNull

(

)

setLimit()

void Jellyfin::Loader::GetYearsParams::setLimit

(

qint32

newLimit

)

setLimitNull()

void Jellyfin::Loader::GetYearsParams::setLimitNull

(

)

setMediaTypes()

void Jellyfin::Loader::GetYearsParams::setMediaTypes

(

QStringList

newMediaTypes

)

setMediaTypesNull()

void Jellyfin::Loader::GetYearsParams::setMediaTypesNull

(

)

setParentId()

void Jellyfin::Loader::GetYearsParams::setParentId

(

QString

newParentId

)

setParentIdNull()

void Jellyfin::Loader::GetYearsParams::setParentIdNull

(

)

setRecursive()

void Jellyfin::Loader::GetYearsParams::setRecursive

(

bool

newRecursive

)

setRecursiveNull()

void Jellyfin::Loader::GetYearsParams::setRecursiveNull

(

)

setSortBy()

void Jellyfin::Loader::GetYearsParams::setSortBy

(

QString

newSortBy

)

setSortByNull()

void Jellyfin::Loader::GetYearsParams::setSortByNull

(

)

setSortOrder()

void Jellyfin::Loader::GetYearsParams::setSortOrder

(

QString

newSortOrder

)

setSortOrderNull()

void Jellyfin::Loader::GetYearsParams::setSortOrderNull

(

)

setStartIndex()

void Jellyfin::Loader::GetYearsParams::setStartIndex

(

qint32

newStartIndex

)

setStartIndexNull()

void Jellyfin::Loader::GetYearsParams::setStartIndexNull

(

)

setUserId()

void Jellyfin::Loader::GetYearsParams::setUserId

(

QString

newUserId

)

setUserIdNull()

void Jellyfin::Loader::GetYearsParams::setUserIdNull

(

)

sortBy()

const QString & Jellyfin::Loader::GetYearsParams::sortBy

(

)

const

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

sortByNull()

bool Jellyfin::Loader::GetYearsParams::sortByNull

(

)

const

sortOrder()

const QString & Jellyfin::Loader::GetYearsParams::sortOrder

(

)

const

Sort Order - Ascending,Descending.

sortOrderNull()

bool Jellyfin::Loader::GetYearsParams::sortOrderNull

(

)

const

startIndex()

const qint32 & Jellyfin::Loader::GetYearsParams::startIndex

(

)

const

Skips over a given number of items within the results. Use for paging.

startIndexNull()

bool Jellyfin::Loader::GetYearsParams::startIndexNull

(

)

const

userId()

const QString & Jellyfin::Loader::GetYearsParams::userId

(

)

const

User Id.

userIdNull()

bool Jellyfin::Loader::GetYearsParams::userIdNull

(

)

const

---

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

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