Jellyfin::Loader::GetPersonsParams Class Reference

#include <requesttypes.h>

Public Member Functions
const QString &	appearsInItemId () const
	Optional. If specified, person results will be filtered on items related to said persons.
void	setAppearsInItemId (QString newAppearsInItemId)
bool	appearsInItemIdNull () const
void	setAppearsInItemIdNull ()
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 &	excludePersonTypes () const
	Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.
void	setExcludePersonTypes (QStringList newExcludePersonTypes)
bool	excludePersonTypesNull () const
void	setExcludePersonTypesNull ()
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 qint32 &	imageTypeLimit () const
	Optional, the max number of images to return, per image type.
void	setImageTypeLimit (qint32 newImageTypeLimit)
bool	imageTypeLimitNull () const
void	setImageTypeLimitNull ()
const bool &	isFavorite () const
	Optional filter by items that are marked as favorite, or not. userId is required.
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 &	personTypes () const
	Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.
void	setPersonTypes (QStringList newPersonTypes)
bool	personTypesNull () const
void	setPersonTypesNull ()
const QString &	searchTerm () const
	The search term.
void	setSearchTerm (QString newSearchTerm)
bool	searchTermNull () const
void	setSearchTermNull ()
const QString &	userId () const
	User id.
void	setUserId (QString newUserId)
bool	userIdNull () const
void	setUserIdNull ()

Member Function Documentation

appearsInItemId()

const QString & Jellyfin::Loader::GetPersonsParams::appearsInItemId

(

)

const

Optional. If specified, person results will be filtered on items related to said persons.

appearsInItemIdNull()

bool Jellyfin::Loader::GetPersonsParams::appearsInItemIdNull

(

)

const

enableImages()

const bool & Jellyfin::Loader::GetPersonsParams::enableImages

(

)

const

Optional, include image information in output.

enableImagesNull()

bool Jellyfin::Loader::GetPersonsParams::enableImagesNull

(

)

const

enableImageTypes()

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

(

)

const

Optional. The image types to include in the output.

enableImageTypesNull()

bool Jellyfin::Loader::GetPersonsParams::enableImageTypesNull

(

)

const

enableUserData()

const bool & Jellyfin::Loader::GetPersonsParams::enableUserData

(

)

const

Optional, include user data.

enableUserDataNull()

bool Jellyfin::Loader::GetPersonsParams::enableUserDataNull

(

)

const

excludePersonTypes()

const QStringList & Jellyfin::Loader::GetPersonsParams::excludePersonTypes

(

)

const

Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.

excludePersonTypesNull()

bool Jellyfin::Loader::GetPersonsParams::excludePersonTypesNull

(

)

const

fields()

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

(

)

const

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

fieldsNull()

bool Jellyfin::Loader::GetPersonsParams::fieldsNull

(

)

const

filters()

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

(

)

const

Optional. Specify additional filters to apply.

filtersNull()

bool Jellyfin::Loader::GetPersonsParams::filtersNull

(

)

const

imageTypeLimit()

const qint32 & Jellyfin::Loader::GetPersonsParams::imageTypeLimit

(

)

const

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

imageTypeLimitNull()

bool Jellyfin::Loader::GetPersonsParams::imageTypeLimitNull

(

)

const

isFavorite()

const bool & Jellyfin::Loader::GetPersonsParams::isFavorite

(

)

const

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

isFavoriteNull()

bool Jellyfin::Loader::GetPersonsParams::isFavoriteNull

(

)

const

limit()

const qint32 & Jellyfin::Loader::GetPersonsParams::limit

(

)

const

Optional. The maximum number of records to return.

limitNull()

bool Jellyfin::Loader::GetPersonsParams::limitNull

(

)

const

personTypes()

const QStringList & Jellyfin::Loader::GetPersonsParams::personTypes

(

)

const

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

personTypesNull()

bool Jellyfin::Loader::GetPersonsParams::personTypesNull

(

)

const

searchTerm()

const QString & Jellyfin::Loader::GetPersonsParams::searchTerm

(

)

const

The search term.

searchTermNull()

bool Jellyfin::Loader::GetPersonsParams::searchTermNull

(

)

const

setAppearsInItemId()

void Jellyfin::Loader::GetPersonsParams::setAppearsInItemId

(

QString

newAppearsInItemId

)

setAppearsInItemIdNull()

void Jellyfin::Loader::GetPersonsParams::setAppearsInItemIdNull

(

)

setEnableImages()

void Jellyfin::Loader::GetPersonsParams::setEnableImages

(

bool

newEnableImages

)

setEnableImagesNull()

void Jellyfin::Loader::GetPersonsParams::setEnableImagesNull

(

)

setEnableImageTypes()

void Jellyfin::Loader::GetPersonsParams::setEnableImageTypes

(

QList< ImageType >

newEnableImageTypes

)

setEnableImageTypesNull()

void Jellyfin::Loader::GetPersonsParams::setEnableImageTypesNull

(

)

setEnableUserData()

void Jellyfin::Loader::GetPersonsParams::setEnableUserData

(

bool

newEnableUserData

)

setEnableUserDataNull()

void Jellyfin::Loader::GetPersonsParams::setEnableUserDataNull

(

)

setExcludePersonTypes()

void Jellyfin::Loader::GetPersonsParams::setExcludePersonTypes

(

QStringList

newExcludePersonTypes

)

setExcludePersonTypesNull()

void Jellyfin::Loader::GetPersonsParams::setExcludePersonTypesNull

(

)

setFields()

void Jellyfin::Loader::GetPersonsParams::setFields

(

QList< ItemFields >

newFields

)

setFieldsNull()

void Jellyfin::Loader::GetPersonsParams::setFieldsNull

(

)

setFilters()

void Jellyfin::Loader::GetPersonsParams::setFilters

(

QList< ItemFilter >

newFilters

)

setFiltersNull()

void Jellyfin::Loader::GetPersonsParams::setFiltersNull

(

)

setImageTypeLimit()

void Jellyfin::Loader::GetPersonsParams::setImageTypeLimit

(

qint32

newImageTypeLimit

)

setImageTypeLimitNull()

void Jellyfin::Loader::GetPersonsParams::setImageTypeLimitNull

(

)

setIsFavorite()

void Jellyfin::Loader::GetPersonsParams::setIsFavorite

(

bool

newIsFavorite

)

setIsFavoriteNull()

void Jellyfin::Loader::GetPersonsParams::setIsFavoriteNull

(

)

setLimit()

void Jellyfin::Loader::GetPersonsParams::setLimit

(

qint32

newLimit

)

setLimitNull()

void Jellyfin::Loader::GetPersonsParams::setLimitNull

(

)

setPersonTypes()

void Jellyfin::Loader::GetPersonsParams::setPersonTypes

(

QStringList

newPersonTypes

)

setPersonTypesNull()

void Jellyfin::Loader::GetPersonsParams::setPersonTypesNull

(

)

setSearchTerm()

void Jellyfin::Loader::GetPersonsParams::setSearchTerm

(

QString

newSearchTerm

)

setSearchTermNull()

void Jellyfin::Loader::GetPersonsParams::setSearchTermNull

(

)

setUserId()

void Jellyfin::Loader::GetPersonsParams::setUserId

(

QString

newUserId

)

setUserIdNull()

void Jellyfin::Loader::GetPersonsParams::setUserIdNull

(

)

userId()

const QString & Jellyfin::Loader::GetPersonsParams::userId

(

)

const

User id.

userIdNull()

bool Jellyfin::Loader::GetPersonsParams::userIdNull

(

)

const

---

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

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