Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::DTO::SearchHint Class Reference

#include <searchhint.h>

Public Member Functions

 SearchHint (QString itemId, QString jellyfinId, QString name, BaseItemKind type, MediaType mediaType, QStringList artists)
 SearchHint (const SearchHint &other)
void replaceData (SearchHint &other)
void setFromJson (QJsonObject source)
QJsonObject toJson () const
QString itemId () const
 Gets or sets the item id.
void setItemId (QString newItemId)
 Gets or sets the item id.
QString jellyfinId () const
 Gets or sets the item id.
void setJellyfinId (QString newJellyfinId)
 Gets or sets the item id.
QString name () const
 Gets or sets the name.
void setName (QString newName)
 Gets or sets the name.
QString matchedTerm () const
 Gets or sets the matched term.
void setMatchedTerm (QString newMatchedTerm)
 Gets or sets the matched term.
bool matchedTermNull () const
void setMatchedTermNull ()
std::optional< qint32 > indexNumber () const
 Gets or sets the index number.
void setIndexNumber (std::optional< qint32 > newIndexNumber)
 Gets or sets the index number.
bool indexNumberNull () const
void setIndexNumberNull ()
std::optional< qint32 > productionYear () const
 Gets or sets the production year.
void setProductionYear (std::optional< qint32 > newProductionYear)
 Gets or sets the production year.
bool productionYearNull () const
void setProductionYearNull ()
std::optional< qint32 > parentIndexNumber () const
 Gets or sets the parent index number.
void setParentIndexNumber (std::optional< qint32 > newParentIndexNumber)
 Gets or sets the parent index number.
bool parentIndexNumberNull () const
void setParentIndexNumberNull ()
QString primaryImageTag () const
 Gets or sets the image tag.
void setPrimaryImageTag (QString newPrimaryImageTag)
 Gets or sets the image tag.
bool primaryImageTagNull () const
void setPrimaryImageTagNull ()
QString thumbImageTag () const
 Gets or sets the thumb image tag.
void setThumbImageTag (QString newThumbImageTag)
 Gets or sets the thumb image tag.
bool thumbImageTagNull () const
void setThumbImageTagNull ()
QString thumbImageItemId () const
 Gets or sets the thumb image item identifier.
void setThumbImageItemId (QString newThumbImageItemId)
 Gets or sets the thumb image item identifier.
bool thumbImageItemIdNull () const
void setThumbImageItemIdNull ()
QString backdropImageTag () const
 Gets or sets the backdrop image tag.
void setBackdropImageTag (QString newBackdropImageTag)
 Gets or sets the backdrop image tag.
bool backdropImageTagNull () const
void setBackdropImageTagNull ()
QString backdropImageItemId () const
 Gets or sets the backdrop image item identifier.
void setBackdropImageItemId (QString newBackdropImageItemId)
 Gets or sets the backdrop image item identifier.
bool backdropImageItemIdNull () const
void setBackdropImageItemIdNull ()
BaseItemKind type () const
void setType (BaseItemKind newType)
std::optional< bool > isFolder () const
 Gets or sets a value indicating whether this instance is folder.
void setIsFolder (std::optional< bool > newIsFolder)
 Gets or sets a value indicating whether this instance is folder.
bool isFolderNull () const
void setIsFolderNull ()
std::optional< qint64 > runTimeTicks () const
 Gets or sets the run time ticks.
void setRunTimeTicks (std::optional< qint64 > newRunTimeTicks)
 Gets or sets the run time ticks.
bool runTimeTicksNull () const
void setRunTimeTicksNull ()
MediaType mediaType () const
void setMediaType (MediaType newMediaType)
QDateTime startDate () const
 Gets or sets the start date.
void setStartDate (QDateTime newStartDate)
 Gets or sets the start date.
bool startDateNull () const
void setStartDateNull ()
QDateTime endDate () const
 Gets or sets the end date.
void setEndDate (QDateTime newEndDate)
 Gets or sets the end date.
bool endDateNull () const
void setEndDateNull ()
QString series () const
 Gets or sets the series.
void setSeries (QString newSeries)
 Gets or sets the series.
bool seriesNull () const
void setSeriesNull ()
QString status () const
 Gets or sets the status.
void setStatus (QString newStatus)
 Gets or sets the status.
bool statusNull () const
void setStatusNull ()
QString album () const
 Gets or sets the album.
void setAlbum (QString newAlbum)
 Gets or sets the album.
bool albumNull () const
void setAlbumNull ()
QString albumId () const
 Gets or sets the album id.
void setAlbumId (QString newAlbumId)
 Gets or sets the album id.
bool albumIdNull () const
void setAlbumIdNull ()
QString albumArtist () const
 Gets or sets the album artist.
void setAlbumArtist (QString newAlbumArtist)
 Gets or sets the album artist.
bool albumArtistNull () const
void setAlbumArtistNull ()
QStringList artists () const
 Gets or sets the artists.
void setArtists (QStringList newArtists)
 Gets or sets the artists.
std::optional< qint32 > songCount () const
 Gets or sets the song count.
void setSongCount (std::optional< qint32 > newSongCount)
 Gets or sets the song count.
bool songCountNull () const
void setSongCountNull ()
std::optional< qint32 > episodeCount () const
 Gets or sets the episode count.
void setEpisodeCount (std::optional< qint32 > newEpisodeCount)
 Gets or sets the episode count.
bool episodeCountNull () const
void setEpisodeCountNull ()
QString channelId () const
 Gets or sets the channel identifier.
void setChannelId (QString newChannelId)
 Gets or sets the channel identifier.
bool channelIdNull () const
void setChannelIdNull ()
QString channelName () const
 Gets or sets the name of the channel.
void setChannelName (QString newChannelName)
 Gets or sets the name of the channel.
bool channelNameNull () const
void setChannelNameNull ()
std::optional< double > primaryImageAspectRatio () const
 Gets or sets the primary image aspect ratio.
void setPrimaryImageAspectRatio (std::optional< double > newPrimaryImageAspectRatio)
 Gets or sets the primary image aspect ratio.
bool primaryImageAspectRatioNull () const
void setPrimaryImageAspectRatioNull ()

Static Public Member Functions

static SearchHint fromJson (QJsonObject source)

Protected Attributes

QString m_itemId
QString m_jellyfinId
QString m_name
QString m_matchedTerm
std::optional< qint32 > m_indexNumber = std::nullopt
std::optional< qint32 > m_productionYear = std::nullopt
std::optional< qint32 > m_parentIndexNumber = std::nullopt
QString m_primaryImageTag
QString m_thumbImageTag
QString m_thumbImageItemId
QString m_backdropImageTag
QString m_backdropImageItemId
BaseItemKind m_type
std::optional< bool > m_isFolder = std::nullopt
std::optional< qint64 > m_runTimeTicks = std::nullopt
MediaType m_mediaType
QDateTime m_startDate
QDateTime m_endDate
QString m_series
QString m_status
QString m_album
QString m_albumId
QString m_albumArtist
QStringList m_artists
std::optional< qint32 > m_songCount = std::nullopt
std::optional< qint32 > m_episodeCount = std::nullopt
QString m_channelId
QString m_channelName
std::optional< double > m_primaryImageAspectRatio = std::nullopt

Constructor & Destructor Documentation

◆ SearchHint() [1/2]

Jellyfin::DTO::SearchHint::SearchHint ( QString itemId,
QString jellyfinId,
QString name,
BaseItemKind type,
MediaType mediaType,
QStringList artists )

◆ SearchHint() [2/2]

Jellyfin::DTO::SearchHint::SearchHint ( const SearchHint & other)

Member Function Documentation

◆ album()

QString Jellyfin::DTO::SearchHint::album ( ) const

Gets or sets the album.

◆ albumArtist()

QString Jellyfin::DTO::SearchHint::albumArtist ( ) const

Gets or sets the album artist.

◆ albumArtistNull()

bool Jellyfin::DTO::SearchHint::albumArtistNull ( ) const

◆ albumId()

QString Jellyfin::DTO::SearchHint::albumId ( ) const

Gets or sets the album id.

◆ albumIdNull()

bool Jellyfin::DTO::SearchHint::albumIdNull ( ) const

◆ albumNull()

bool Jellyfin::DTO::SearchHint::albumNull ( ) const

◆ artists()

QStringList Jellyfin::DTO::SearchHint::artists ( ) const

Gets or sets the artists.

◆ backdropImageItemId()

QString Jellyfin::DTO::SearchHint::backdropImageItemId ( ) const

Gets or sets the backdrop image item identifier.

◆ backdropImageItemIdNull()

bool Jellyfin::DTO::SearchHint::backdropImageItemIdNull ( ) const

◆ backdropImageTag()

QString Jellyfin::DTO::SearchHint::backdropImageTag ( ) const

Gets or sets the backdrop image tag.

◆ backdropImageTagNull()

bool Jellyfin::DTO::SearchHint::backdropImageTagNull ( ) const

◆ channelId()

QString Jellyfin::DTO::SearchHint::channelId ( ) const

Gets or sets the channel identifier.

◆ channelIdNull()

bool Jellyfin::DTO::SearchHint::channelIdNull ( ) const

◆ channelName()

QString Jellyfin::DTO::SearchHint::channelName ( ) const

Gets or sets the name of the channel.

◆ channelNameNull()

bool Jellyfin::DTO::SearchHint::channelNameNull ( ) const

◆ endDate()

QDateTime Jellyfin::DTO::SearchHint::endDate ( ) const

Gets or sets the end date.

◆ endDateNull()

bool Jellyfin::DTO::SearchHint::endDateNull ( ) const

◆ episodeCount()

std::optional< qint32 > Jellyfin::DTO::SearchHint::episodeCount ( ) const

Gets or sets the episode count.

◆ episodeCountNull()

bool Jellyfin::DTO::SearchHint::episodeCountNull ( ) const

◆ fromJson()

SearchHint Jellyfin::DTO::SearchHint::fromJson ( QJsonObject source)
static

◆ indexNumber()

std::optional< qint32 > Jellyfin::DTO::SearchHint::indexNumber ( ) const

Gets or sets the index number.

◆ indexNumberNull()

bool Jellyfin::DTO::SearchHint::indexNumberNull ( ) const

◆ isFolder()

std::optional< bool > Jellyfin::DTO::SearchHint::isFolder ( ) const

Gets or sets a value indicating whether this instance is folder.

◆ isFolderNull()

bool Jellyfin::DTO::SearchHint::isFolderNull ( ) const

◆ itemId()

QString Jellyfin::DTO::SearchHint::itemId ( ) const

Gets or sets the item id.

◆ jellyfinId()

QString Jellyfin::DTO::SearchHint::jellyfinId ( ) const

Gets or sets the item id.

◆ matchedTerm()

QString Jellyfin::DTO::SearchHint::matchedTerm ( ) const

Gets or sets the matched term.

◆ matchedTermNull()

bool Jellyfin::DTO::SearchHint::matchedTermNull ( ) const

◆ mediaType()

MediaType Jellyfin::DTO::SearchHint::mediaType ( ) const

◆ name()

QString Jellyfin::DTO::SearchHint::name ( ) const

Gets or sets the name.

◆ parentIndexNumber()

std::optional< qint32 > Jellyfin::DTO::SearchHint::parentIndexNumber ( ) const

Gets or sets the parent index number.

◆ parentIndexNumberNull()

bool Jellyfin::DTO::SearchHint::parentIndexNumberNull ( ) const

◆ primaryImageAspectRatio()

std::optional< double > Jellyfin::DTO::SearchHint::primaryImageAspectRatio ( ) const

Gets or sets the primary image aspect ratio.

◆ primaryImageAspectRatioNull()

bool Jellyfin::DTO::SearchHint::primaryImageAspectRatioNull ( ) const

◆ primaryImageTag()

QString Jellyfin::DTO::SearchHint::primaryImageTag ( ) const

Gets or sets the image tag.

◆ primaryImageTagNull()

bool Jellyfin::DTO::SearchHint::primaryImageTagNull ( ) const

◆ productionYear()

std::optional< qint32 > Jellyfin::DTO::SearchHint::productionYear ( ) const

Gets or sets the production year.

◆ productionYearNull()

bool Jellyfin::DTO::SearchHint::productionYearNull ( ) const

◆ replaceData()

void Jellyfin::DTO::SearchHint::replaceData ( SearchHint & other)

Replaces the data being hold by this class with that of the other.

◆ runTimeTicks()

std::optional< qint64 > Jellyfin::DTO::SearchHint::runTimeTicks ( ) const

Gets or sets the run time ticks.

◆ runTimeTicksNull()

bool Jellyfin::DTO::SearchHint::runTimeTicksNull ( ) const

◆ series()

QString Jellyfin::DTO::SearchHint::series ( ) const

Gets or sets the series.

◆ seriesNull()

bool Jellyfin::DTO::SearchHint::seriesNull ( ) const

◆ setAlbum()

void Jellyfin::DTO::SearchHint::setAlbum ( QString newAlbum)

Gets or sets the album.

◆ setAlbumArtist()

void Jellyfin::DTO::SearchHint::setAlbumArtist ( QString newAlbumArtist)

Gets or sets the album artist.

◆ setAlbumArtistNull()

void Jellyfin::DTO::SearchHint::setAlbumArtistNull ( )

◆ setAlbumId()

void Jellyfin::DTO::SearchHint::setAlbumId ( QString newAlbumId)

Gets or sets the album id.

◆ setAlbumIdNull()

void Jellyfin::DTO::SearchHint::setAlbumIdNull ( )

◆ setAlbumNull()

void Jellyfin::DTO::SearchHint::setAlbumNull ( )

◆ setArtists()

void Jellyfin::DTO::SearchHint::setArtists ( QStringList newArtists)

Gets or sets the artists.

◆ setBackdropImageItemId()

void Jellyfin::DTO::SearchHint::setBackdropImageItemId ( QString newBackdropImageItemId)

Gets or sets the backdrop image item identifier.

◆ setBackdropImageItemIdNull()

void Jellyfin::DTO::SearchHint::setBackdropImageItemIdNull ( )

◆ setBackdropImageTag()

void Jellyfin::DTO::SearchHint::setBackdropImageTag ( QString newBackdropImageTag)

Gets or sets the backdrop image tag.

◆ setBackdropImageTagNull()

void Jellyfin::DTO::SearchHint::setBackdropImageTagNull ( )

◆ setChannelId()

void Jellyfin::DTO::SearchHint::setChannelId ( QString newChannelId)

Gets or sets the channel identifier.

◆ setChannelIdNull()

void Jellyfin::DTO::SearchHint::setChannelIdNull ( )

◆ setChannelName()

void Jellyfin::DTO::SearchHint::setChannelName ( QString newChannelName)

Gets or sets the name of the channel.

◆ setChannelNameNull()

void Jellyfin::DTO::SearchHint::setChannelNameNull ( )

◆ setEndDate()

void Jellyfin::DTO::SearchHint::setEndDate ( QDateTime newEndDate)

Gets or sets the end date.

◆ setEndDateNull()

void Jellyfin::DTO::SearchHint::setEndDateNull ( )

◆ setEpisodeCount()

void Jellyfin::DTO::SearchHint::setEpisodeCount ( std::optional< qint32 > newEpisodeCount)

Gets or sets the episode count.

◆ setEpisodeCountNull()

void Jellyfin::DTO::SearchHint::setEpisodeCountNull ( )

◆ setFromJson()

void Jellyfin::DTO::SearchHint::setFromJson ( QJsonObject source)

◆ setIndexNumber()

void Jellyfin::DTO::SearchHint::setIndexNumber ( std::optional< qint32 > newIndexNumber)

Gets or sets the index number.

◆ setIndexNumberNull()

void Jellyfin::DTO::SearchHint::setIndexNumberNull ( )

◆ setIsFolder()

void Jellyfin::DTO::SearchHint::setIsFolder ( std::optional< bool > newIsFolder)

Gets or sets a value indicating whether this instance is folder.

◆ setIsFolderNull()

void Jellyfin::DTO::SearchHint::setIsFolderNull ( )

◆ setItemId()

void Jellyfin::DTO::SearchHint::setItemId ( QString newItemId)

Gets or sets the item id.

◆ setJellyfinId()

void Jellyfin::DTO::SearchHint::setJellyfinId ( QString newJellyfinId)

Gets or sets the item id.

◆ setMatchedTerm()

void Jellyfin::DTO::SearchHint::setMatchedTerm ( QString newMatchedTerm)

Gets or sets the matched term.

◆ setMatchedTermNull()

void Jellyfin::DTO::SearchHint::setMatchedTermNull ( )

◆ setMediaType()

void Jellyfin::DTO::SearchHint::setMediaType ( MediaType newMediaType)

◆ setName()

void Jellyfin::DTO::SearchHint::setName ( QString newName)

Gets or sets the name.

◆ setParentIndexNumber()

void Jellyfin::DTO::SearchHint::setParentIndexNumber ( std::optional< qint32 > newParentIndexNumber)

Gets or sets the parent index number.

◆ setParentIndexNumberNull()

void Jellyfin::DTO::SearchHint::setParentIndexNumberNull ( )

◆ setPrimaryImageAspectRatio()

void Jellyfin::DTO::SearchHint::setPrimaryImageAspectRatio ( std::optional< double > newPrimaryImageAspectRatio)

Gets or sets the primary image aspect ratio.

◆ setPrimaryImageAspectRatioNull()

void Jellyfin::DTO::SearchHint::setPrimaryImageAspectRatioNull ( )

◆ setPrimaryImageTag()

void Jellyfin::DTO::SearchHint::setPrimaryImageTag ( QString newPrimaryImageTag)

Gets or sets the image tag.

◆ setPrimaryImageTagNull()

void Jellyfin::DTO::SearchHint::setPrimaryImageTagNull ( )

◆ setProductionYear()

void Jellyfin::DTO::SearchHint::setProductionYear ( std::optional< qint32 > newProductionYear)

Gets or sets the production year.

◆ setProductionYearNull()

void Jellyfin::DTO::SearchHint::setProductionYearNull ( )

◆ setRunTimeTicks()

void Jellyfin::DTO::SearchHint::setRunTimeTicks ( std::optional< qint64 > newRunTimeTicks)

Gets or sets the run time ticks.

◆ setRunTimeTicksNull()

void Jellyfin::DTO::SearchHint::setRunTimeTicksNull ( )

◆ setSeries()

void Jellyfin::DTO::SearchHint::setSeries ( QString newSeries)

Gets or sets the series.

◆ setSeriesNull()

void Jellyfin::DTO::SearchHint::setSeriesNull ( )

◆ setSongCount()

void Jellyfin::DTO::SearchHint::setSongCount ( std::optional< qint32 > newSongCount)

Gets or sets the song count.

◆ setSongCountNull()

void Jellyfin::DTO::SearchHint::setSongCountNull ( )

◆ setStartDate()

void Jellyfin::DTO::SearchHint::setStartDate ( QDateTime newStartDate)

Gets or sets the start date.

◆ setStartDateNull()

void Jellyfin::DTO::SearchHint::setStartDateNull ( )

◆ setStatus()

void Jellyfin::DTO::SearchHint::setStatus ( QString newStatus)

Gets or sets the status.

◆ setStatusNull()

void Jellyfin::DTO::SearchHint::setStatusNull ( )

◆ setThumbImageItemId()

void Jellyfin::DTO::SearchHint::setThumbImageItemId ( QString newThumbImageItemId)

Gets or sets the thumb image item identifier.

◆ setThumbImageItemIdNull()

void Jellyfin::DTO::SearchHint::setThumbImageItemIdNull ( )

◆ setThumbImageTag()

void Jellyfin::DTO::SearchHint::setThumbImageTag ( QString newThumbImageTag)

Gets or sets the thumb image tag.

◆ setThumbImageTagNull()

void Jellyfin::DTO::SearchHint::setThumbImageTagNull ( )

◆ setType()

void Jellyfin::DTO::SearchHint::setType ( BaseItemKind newType)

◆ songCount()

std::optional< qint32 > Jellyfin::DTO::SearchHint::songCount ( ) const

Gets or sets the song count.

◆ songCountNull()

bool Jellyfin::DTO::SearchHint::songCountNull ( ) const

◆ startDate()

QDateTime Jellyfin::DTO::SearchHint::startDate ( ) const

Gets or sets the start date.

◆ startDateNull()

bool Jellyfin::DTO::SearchHint::startDateNull ( ) const

◆ status()

QString Jellyfin::DTO::SearchHint::status ( ) const

Gets or sets the status.

◆ statusNull()

bool Jellyfin::DTO::SearchHint::statusNull ( ) const

◆ thumbImageItemId()

QString Jellyfin::DTO::SearchHint::thumbImageItemId ( ) const

Gets or sets the thumb image item identifier.

◆ thumbImageItemIdNull()

bool Jellyfin::DTO::SearchHint::thumbImageItemIdNull ( ) const

◆ thumbImageTag()

QString Jellyfin::DTO::SearchHint::thumbImageTag ( ) const

Gets or sets the thumb image tag.

◆ thumbImageTagNull()

bool Jellyfin::DTO::SearchHint::thumbImageTagNull ( ) const

◆ toJson()

QJsonObject Jellyfin::DTO::SearchHint::toJson ( ) const

◆ type()

BaseItemKind Jellyfin::DTO::SearchHint::type ( ) const

Member Data Documentation

◆ m_album

QString Jellyfin::DTO::SearchHint::m_album
protected

◆ m_albumArtist

QString Jellyfin::DTO::SearchHint::m_albumArtist
protected

◆ m_albumId

QString Jellyfin::DTO::SearchHint::m_albumId
protected

◆ m_artists

QStringList Jellyfin::DTO::SearchHint::m_artists
protected

◆ m_backdropImageItemId

QString Jellyfin::DTO::SearchHint::m_backdropImageItemId
protected

◆ m_backdropImageTag

QString Jellyfin::DTO::SearchHint::m_backdropImageTag
protected

◆ m_channelId

QString Jellyfin::DTO::SearchHint::m_channelId
protected

◆ m_channelName

QString Jellyfin::DTO::SearchHint::m_channelName
protected

◆ m_endDate

QDateTime Jellyfin::DTO::SearchHint::m_endDate
protected

◆ m_episodeCount

std::optional<qint32> Jellyfin::DTO::SearchHint::m_episodeCount = std::nullopt
protected

◆ m_indexNumber

std::optional<qint32> Jellyfin::DTO::SearchHint::m_indexNumber = std::nullopt
protected

◆ m_isFolder

std::optional<bool> Jellyfin::DTO::SearchHint::m_isFolder = std::nullopt
protected

◆ m_itemId

QString Jellyfin::DTO::SearchHint::m_itemId
protected

◆ m_jellyfinId

QString Jellyfin::DTO::SearchHint::m_jellyfinId
protected

◆ m_matchedTerm

QString Jellyfin::DTO::SearchHint::m_matchedTerm
protected

◆ m_mediaType

MediaType Jellyfin::DTO::SearchHint::m_mediaType
protected

◆ m_name

QString Jellyfin::DTO::SearchHint::m_name
protected

◆ m_parentIndexNumber

std::optional<qint32> Jellyfin::DTO::SearchHint::m_parentIndexNumber = std::nullopt
protected

◆ m_primaryImageAspectRatio

std::optional<double> Jellyfin::DTO::SearchHint::m_primaryImageAspectRatio = std::nullopt
protected

◆ m_primaryImageTag

QString Jellyfin::DTO::SearchHint::m_primaryImageTag
protected

◆ m_productionYear

std::optional<qint32> Jellyfin::DTO::SearchHint::m_productionYear = std::nullopt
protected

◆ m_runTimeTicks

std::optional<qint64> Jellyfin::DTO::SearchHint::m_runTimeTicks = std::nullopt
protected

◆ m_series

QString Jellyfin::DTO::SearchHint::m_series
protected

◆ m_songCount

std::optional<qint32> Jellyfin::DTO::SearchHint::m_songCount = std::nullopt
protected

◆ m_startDate

QDateTime Jellyfin::DTO::SearchHint::m_startDate
protected

◆ m_status

QString Jellyfin::DTO::SearchHint::m_status
protected

◆ m_thumbImageItemId

QString Jellyfin::DTO::SearchHint::m_thumbImageItemId
protected

◆ m_thumbImageTag

QString Jellyfin::DTO::SearchHint::m_thumbImageTag
protected

◆ m_type

BaseItemKind Jellyfin::DTO::SearchHint::m_type
protected

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