Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::Loader::GetStudiosParams 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 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 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 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 & 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 QString & userId () const
 User id.
 
void setUserId (QString newUserId)
 
bool userIdNull () const
 
void setUserIdNull ()
 

Member Function Documentation

◆ enableImages()

const bool & Jellyfin::Loader::GetStudiosParams::enableImages ( ) const

Optional, include image information in output.

◆ enableImagesNull()

bool Jellyfin::Loader::GetStudiosParams::enableImagesNull ( ) const

◆ enableImageTypes()

const QList< ImageType > & Jellyfin::Loader::GetStudiosParams::enableImageTypes ( ) const

Optional. The image types to include in the output.

◆ enableImageTypesNull()

bool Jellyfin::Loader::GetStudiosParams::enableImageTypesNull ( ) const

◆ enableTotalRecordCount()

const bool & Jellyfin::Loader::GetStudiosParams::enableTotalRecordCount ( ) const

Total record count.

◆ enableTotalRecordCountNull()

bool Jellyfin::Loader::GetStudiosParams::enableTotalRecordCountNull ( ) const

◆ enableUserData()

const bool & Jellyfin::Loader::GetStudiosParams::enableUserData ( ) const

Optional, include user data.

◆ enableUserDataNull()

bool Jellyfin::Loader::GetStudiosParams::enableUserDataNull ( ) const

◆ excludeItemTypes()

const QStringList & Jellyfin::Loader::GetStudiosParams::excludeItemTypes ( ) const

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

◆ excludeItemTypesNull()

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

◆ fields()

const QList< ItemFields > & Jellyfin::Loader::GetStudiosParams::fields ( ) const

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

◆ fieldsNull()

bool Jellyfin::Loader::GetStudiosParams::fieldsNull ( ) const

◆ imageTypeLimit()

const qint32 & Jellyfin::Loader::GetStudiosParams::imageTypeLimit ( ) const

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

◆ imageTypeLimitNull()

bool Jellyfin::Loader::GetStudiosParams::imageTypeLimitNull ( ) const

◆ includeItemTypes()

const QStringList & Jellyfin::Loader::GetStudiosParams::includeItemTypes ( ) const

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

◆ includeItemTypesNull()

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

◆ isFavorite()

const bool & Jellyfin::Loader::GetStudiosParams::isFavorite ( ) const

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

◆ isFavoriteNull()

bool Jellyfin::Loader::GetStudiosParams::isFavoriteNull ( ) const

◆ limit()

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

Optional. The maximum number of records to return.

◆ limitNull()

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

◆ nameLessThan()

const QString & Jellyfin::Loader::GetStudiosParams::nameLessThan ( ) const

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

◆ nameLessThanNull()

bool Jellyfin::Loader::GetStudiosParams::nameLessThanNull ( ) const

◆ nameStartsWith()

const QString & Jellyfin::Loader::GetStudiosParams::nameStartsWith ( ) const

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

◆ nameStartsWithNull()

bool Jellyfin::Loader::GetStudiosParams::nameStartsWithNull ( ) const

◆ nameStartsWithOrGreater()

const QString & Jellyfin::Loader::GetStudiosParams::nameStartsWithOrGreater ( ) const

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

◆ nameStartsWithOrGreaterNull()

bool Jellyfin::Loader::GetStudiosParams::nameStartsWithOrGreaterNull ( ) const

◆ parentId()

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

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

◆ parentIdNull()

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

◆ searchTerm()

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

Optional. Search term.

◆ searchTermNull()

bool Jellyfin::Loader::GetStudiosParams::searchTermNull ( ) const

◆ setEnableImages()

void Jellyfin::Loader::GetStudiosParams::setEnableImages ( bool newEnableImages)

◆ setEnableImagesNull()

void Jellyfin::Loader::GetStudiosParams::setEnableImagesNull ( )

◆ setEnableImageTypes()

void Jellyfin::Loader::GetStudiosParams::setEnableImageTypes ( QList< ImageType > newEnableImageTypes)

◆ setEnableImageTypesNull()

void Jellyfin::Loader::GetStudiosParams::setEnableImageTypesNull ( )

◆ setEnableTotalRecordCount()

void Jellyfin::Loader::GetStudiosParams::setEnableTotalRecordCount ( bool newEnableTotalRecordCount)

◆ setEnableTotalRecordCountNull()

void Jellyfin::Loader::GetStudiosParams::setEnableTotalRecordCountNull ( )

◆ setEnableUserData()

void Jellyfin::Loader::GetStudiosParams::setEnableUserData ( bool newEnableUserData)

◆ setEnableUserDataNull()

void Jellyfin::Loader::GetStudiosParams::setEnableUserDataNull ( )

◆ setExcludeItemTypes()

void Jellyfin::Loader::GetStudiosParams::setExcludeItemTypes ( QStringList newExcludeItemTypes)

◆ setExcludeItemTypesNull()

void Jellyfin::Loader::GetStudiosParams::setExcludeItemTypesNull ( )

◆ setFields()

void Jellyfin::Loader::GetStudiosParams::setFields ( QList< ItemFields > newFields)

◆ setFieldsNull()

void Jellyfin::Loader::GetStudiosParams::setFieldsNull ( )

◆ setImageTypeLimit()

void Jellyfin::Loader::GetStudiosParams::setImageTypeLimit ( qint32 newImageTypeLimit)

◆ setImageTypeLimitNull()

void Jellyfin::Loader::GetStudiosParams::setImageTypeLimitNull ( )

◆ setIncludeItemTypes()

void Jellyfin::Loader::GetStudiosParams::setIncludeItemTypes ( QStringList newIncludeItemTypes)

◆ setIncludeItemTypesNull()

void Jellyfin::Loader::GetStudiosParams::setIncludeItemTypesNull ( )

◆ setIsFavorite()

void Jellyfin::Loader::GetStudiosParams::setIsFavorite ( bool newIsFavorite)

◆ setIsFavoriteNull()

void Jellyfin::Loader::GetStudiosParams::setIsFavoriteNull ( )

◆ setLimit()

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

◆ setLimitNull()

void Jellyfin::Loader::GetStudiosParams::setLimitNull ( )

◆ setNameLessThan()

void Jellyfin::Loader::GetStudiosParams::setNameLessThan ( QString newNameLessThan)

◆ setNameLessThanNull()

void Jellyfin::Loader::GetStudiosParams::setNameLessThanNull ( )

◆ setNameStartsWith()

void Jellyfin::Loader::GetStudiosParams::setNameStartsWith ( QString newNameStartsWith)

◆ setNameStartsWithNull()

void Jellyfin::Loader::GetStudiosParams::setNameStartsWithNull ( )

◆ setNameStartsWithOrGreater()

void Jellyfin::Loader::GetStudiosParams::setNameStartsWithOrGreater ( QString newNameStartsWithOrGreater)

◆ setNameStartsWithOrGreaterNull()

void Jellyfin::Loader::GetStudiosParams::setNameStartsWithOrGreaterNull ( )

◆ setParentId()

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

◆ setParentIdNull()

void Jellyfin::Loader::GetStudiosParams::setParentIdNull ( )

◆ setSearchTerm()

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

◆ setSearchTermNull()

void Jellyfin::Loader::GetStudiosParams::setSearchTermNull ( )

◆ setStartIndex()

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

◆ setStartIndexNull()

void Jellyfin::Loader::GetStudiosParams::setStartIndexNull ( )

◆ setUserId()

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

◆ setUserIdNull()

void Jellyfin::Loader::GetStudiosParams::setUserIdNull ( )

◆ startIndex()

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

◆ userId()

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

User id.

◆ userIdNull()

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

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