Jellyfin::Loader::GetEpisodesParams Class Reference

#include <requesttypes.h>

Public Member Functions
const QString &	seriesId () const
	The series id.
void	setSeriesId (QString newSeriesId)
const QString &	adjacentTo () const
	Optional. Return items that are siblings of a supplied item.
void	setAdjacentTo (QString newAdjacentTo)
bool	adjacentToNull () const
void	setAdjacentToNull ()
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 QList< ItemFields > &	fields () const
	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
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 bool &	isMissing () const
	Optional. Filter by items that are missing episodes or not.
void	setIsMissing (bool newIsMissing)
bool	isMissingNull () const
void	setIsMissingNull ()
const qint32 &	limit () const
	Optional. The maximum number of records to return.
void	setLimit (qint32 newLimit)
bool	limitNull () const
void	setLimitNull ()
const qint32 &	season () const
	Optional filter by season number.
void	setSeason (qint32 newSeason)
bool	seasonNull () const
void	setSeasonNull ()
const QString &	seasonId () const
	Optional. Filter by season id.
void	setSeasonId (QString newSeasonId)
bool	seasonIdNull () const
void	setSeasonIdNull ()
const ItemSortBy &	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 (ItemSortBy newSortBy)
bool	sortByNull () const
void	setSortByNull ()
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 &	startItemId () const
	Optional. Skip through the list until a given item is found.
void	setStartItemId (QString newStartItemId)
bool	startItemIdNull () const
void	setStartItemIdNull ()
const QString &	userId () const
	The user id.
void	setUserId (QString newUserId)
bool	userIdNull () const
void	setUserIdNull ()

Member Function Documentation

adjacentTo()

const QString & Jellyfin::Loader::GetEpisodesParams::adjacentTo

(

)

const

Optional. Return items that are siblings of a supplied item.

adjacentToNull()

bool Jellyfin::Loader::GetEpisodesParams::adjacentToNull

(

)

const

enableImages()

const bool & Jellyfin::Loader::GetEpisodesParams::enableImages

(

)

const

Optional, include image information in output.

enableImagesNull()

bool Jellyfin::Loader::GetEpisodesParams::enableImagesNull

(

)

const

enableImageTypes()

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

(

)

const

Optional. The image types to include in the output.

enableImageTypesNull()

bool Jellyfin::Loader::GetEpisodesParams::enableImageTypesNull

(

)

const

enableUserData()

const bool & Jellyfin::Loader::GetEpisodesParams::enableUserData

(

)

const

Optional. Include user data.

enableUserDataNull()

bool Jellyfin::Loader::GetEpisodesParams::enableUserDataNull

(

)

const

fields()

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

(

)

const

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

fieldsNull()

bool Jellyfin::Loader::GetEpisodesParams::fieldsNull

(

)

const

imageTypeLimit()

const qint32 & Jellyfin::Loader::GetEpisodesParams::imageTypeLimit

(

)

const

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

imageTypeLimitNull()

bool Jellyfin::Loader::GetEpisodesParams::imageTypeLimitNull

(

)

const

isMissing()

const bool & Jellyfin::Loader::GetEpisodesParams::isMissing

(

)

const

Optional. Filter by items that are missing episodes or not.

isMissingNull()

bool Jellyfin::Loader::GetEpisodesParams::isMissingNull

(

)

const

limit()

const qint32 & Jellyfin::Loader::GetEpisodesParams::limit

(

)

const

Optional. The maximum number of records to return.

limitNull()

bool Jellyfin::Loader::GetEpisodesParams::limitNull

(

)

const

season()

const qint32 & Jellyfin::Loader::GetEpisodesParams::season

(

)

const

Optional filter by season number.

seasonId()

const QString & Jellyfin::Loader::GetEpisodesParams::seasonId

(

)

const

Optional. Filter by season id.

seasonIdNull()

bool Jellyfin::Loader::GetEpisodesParams::seasonIdNull

(

)

const

seasonNull()

bool Jellyfin::Loader::GetEpisodesParams::seasonNull

(

)

const

seriesId()

const QString & Jellyfin::Loader::GetEpisodesParams::seriesId

(

)

const

The series id.

setAdjacentTo()

void Jellyfin::Loader::GetEpisodesParams::setAdjacentTo

(

QString

newAdjacentTo

)

setAdjacentToNull()

void Jellyfin::Loader::GetEpisodesParams::setAdjacentToNull

(

)

setEnableImages()

void Jellyfin::Loader::GetEpisodesParams::setEnableImages

(

bool

newEnableImages

)

setEnableImagesNull()

void Jellyfin::Loader::GetEpisodesParams::setEnableImagesNull

(

)

setEnableImageTypes()

void Jellyfin::Loader::GetEpisodesParams::setEnableImageTypes

(

QList< ImageType >

newEnableImageTypes

)

setEnableImageTypesNull()

void Jellyfin::Loader::GetEpisodesParams::setEnableImageTypesNull

(

)

setEnableUserData()

void Jellyfin::Loader::GetEpisodesParams::setEnableUserData

(

bool

newEnableUserData

)

setEnableUserDataNull()

void Jellyfin::Loader::GetEpisodesParams::setEnableUserDataNull

(

)

setFields()

void Jellyfin::Loader::GetEpisodesParams::setFields

(

QList< ItemFields >

newFields

)

setFieldsNull()

void Jellyfin::Loader::GetEpisodesParams::setFieldsNull

(

)

setImageTypeLimit()

void Jellyfin::Loader::GetEpisodesParams::setImageTypeLimit

(

qint32

newImageTypeLimit

)

setImageTypeLimitNull()

void Jellyfin::Loader::GetEpisodesParams::setImageTypeLimitNull

(

)

setIsMissing()

void Jellyfin::Loader::GetEpisodesParams::setIsMissing

(

bool

newIsMissing

)

setIsMissingNull()

void Jellyfin::Loader::GetEpisodesParams::setIsMissingNull

(

)

setLimit()

void Jellyfin::Loader::GetEpisodesParams::setLimit

(

qint32

newLimit

)

setLimitNull()

void Jellyfin::Loader::GetEpisodesParams::setLimitNull

(

)

setSeason()

void Jellyfin::Loader::GetEpisodesParams::setSeason

(

qint32

newSeason

)

setSeasonId()

void Jellyfin::Loader::GetEpisodesParams::setSeasonId

(

QString

newSeasonId

)

setSeasonIdNull()

void Jellyfin::Loader::GetEpisodesParams::setSeasonIdNull

(

)

setSeasonNull()

void Jellyfin::Loader::GetEpisodesParams::setSeasonNull

(

)

setSeriesId()

void Jellyfin::Loader::GetEpisodesParams::setSeriesId

(

QString

newSeriesId

)

setSortBy()

void Jellyfin::Loader::GetEpisodesParams::setSortBy

(

ItemSortBy

newSortBy

)

setSortByNull()

void Jellyfin::Loader::GetEpisodesParams::setSortByNull

(

)

setStartIndex()

void Jellyfin::Loader::GetEpisodesParams::setStartIndex

(

qint32

newStartIndex

)

setStartIndexNull()

void Jellyfin::Loader::GetEpisodesParams::setStartIndexNull

(

)

setStartItemId()

void Jellyfin::Loader::GetEpisodesParams::setStartItemId

(

QString

newStartItemId

)

setStartItemIdNull()

void Jellyfin::Loader::GetEpisodesParams::setStartItemIdNull

(

)

setUserId()

void Jellyfin::Loader::GetEpisodesParams::setUserId

(

QString

newUserId

)

setUserIdNull()

void Jellyfin::Loader::GetEpisodesParams::setUserIdNull

(

)

sortBy()

const ItemSortBy & Jellyfin::Loader::GetEpisodesParams::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::GetEpisodesParams::sortByNull

(

)

const

startIndex()

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

(

)

const

startItemId()

const QString & Jellyfin::Loader::GetEpisodesParams::startItemId

(

)

const

Optional. Skip through the list until a given item is found.

startItemIdNull()

bool Jellyfin::Loader::GetEpisodesParams::startItemIdNull

(

)

const

userId()

const QString & Jellyfin::Loader::GetEpisodesParams::userId

(

)

const

The user id.

userIdNull()

bool Jellyfin::Loader::GetEpisodesParams::userIdNull

(

)

const

---

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

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