searchhint.h

Go to the documentation of this file.

/*
 * Sailfin: a Jellyfin client written using Qt
 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
/*
 * WARNING: THIS IS AN AUTOMATICALLY GENERATED FILE! PLEASE DO NOT EDIT THIS, AS YOUR EDITS WILL GET
 * OVERWRITTEN AT SOME POINT! 
 *
 * If there is a bug in this file, please fix the code generator used to generate this file found in
 * core/openapigenerator.d. 
 *
 * This file is generated based on Jellyfin's OpenAPI description, "openapi.json". Please update that
 * file with a newer file if needed instead of manually updating the files.
 */
 
#ifndef JELLYFIN_DTO_SEARCHHINT_H
#define JELLYFIN_DTO_SEARCHHINT_H
 
#include <QDateTime>
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/dto/baseitemkind.h"
#include "JellyfinQt/dto/mediatype.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class SearchHint {
public:
    SearchHint( 
        QString itemId,         
        QString jellyfinId,         
        QString name,                                                                                   
        BaseItemKind type,                          
        MediaType mediaType,                                                                    
        QStringList artists                                             
    );
 
    SearchHint(const SearchHint &other);
    
    void replaceData(SearchHint &other);
    
    static SearchHint fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    QString itemId() const;
    void setItemId(QString newItemId);

    QString jellyfinId() const;
    void setJellyfinId(QString newJellyfinId);

    QString name() const;
    void setName(QString newName);

    QString matchedTerm() const;
    void setMatchedTerm(QString newMatchedTerm);
    bool matchedTermNull() const;
    void setMatchedTermNull();

    std::optional<qint32> indexNumber() const;
    void setIndexNumber(std::optional<qint32> newIndexNumber);
    bool indexNumberNull() const;
    void setIndexNumberNull();

    std::optional<qint32> productionYear() const;
    void setProductionYear(std::optional<qint32> newProductionYear);
    bool productionYearNull() const;
    void setProductionYearNull();

    std::optional<qint32> parentIndexNumber() const;
    void setParentIndexNumber(std::optional<qint32> newParentIndexNumber);
    bool parentIndexNumberNull() const;
    void setParentIndexNumberNull();

    QString primaryImageTag() const;
    void setPrimaryImageTag(QString newPrimaryImageTag);
    bool primaryImageTagNull() const;
    void setPrimaryImageTagNull();

    QString thumbImageTag() const;
    void setThumbImageTag(QString newThumbImageTag);
    bool thumbImageTagNull() const;
    void setThumbImageTagNull();

    QString thumbImageItemId() const;
    void setThumbImageItemId(QString newThumbImageItemId);
    bool thumbImageItemIdNull() const;
    void setThumbImageItemIdNull();

    QString backdropImageTag() const;
    void setBackdropImageTag(QString newBackdropImageTag);
    bool backdropImageTagNull() const;
    void setBackdropImageTagNull();

    QString backdropImageItemId() const;
    void setBackdropImageItemId(QString newBackdropImageItemId);
    bool backdropImageItemIdNull() const;
    void setBackdropImageItemIdNull();
 
 
    BaseItemKind type() const;
 
    void setType(BaseItemKind newType);

    std::optional<bool> isFolder() const;
    void setIsFolder(std::optional<bool> newIsFolder);
    bool isFolderNull() const;
    void setIsFolderNull();

    std::optional<qint64> runTimeTicks() const;
    void setRunTimeTicks(std::optional<qint64> newRunTimeTicks);
    bool runTimeTicksNull() const;
    void setRunTimeTicksNull();
 
 
    MediaType mediaType() const;
 
    void setMediaType(MediaType newMediaType);

    QDateTime startDate() const;
    void setStartDate(QDateTime newStartDate);
    bool startDateNull() const;
    void setStartDateNull();

    QDateTime endDate() const;
    void setEndDate(QDateTime newEndDate);
    bool endDateNull() const;
    void setEndDateNull();

    QString series() const;
    void setSeries(QString newSeries);
    bool seriesNull() const;
    void setSeriesNull();

    QString status() const;
    void setStatus(QString newStatus);
    bool statusNull() const;
    void setStatusNull();

    QString album() const;
    void setAlbum(QString newAlbum);
    bool albumNull() const;
    void setAlbumNull();

    QString albumId() const;
    void setAlbumId(QString newAlbumId);
    bool albumIdNull() const;
    void setAlbumIdNull();

    QString albumArtist() const;
    void setAlbumArtist(QString newAlbumArtist);
    bool albumArtistNull() const;
    void setAlbumArtistNull();

    QStringList artists() const;
    void setArtists(QStringList newArtists);

    std::optional<qint32> songCount() const;
    void setSongCount(std::optional<qint32> newSongCount);
    bool songCountNull() const;
    void setSongCountNull();

    std::optional<qint32> episodeCount() const;
    void setEpisodeCount(std::optional<qint32> newEpisodeCount);
    bool episodeCountNull() const;
    void setEpisodeCountNull();

    QString channelId() const;
    void setChannelId(QString newChannelId);
    bool channelIdNull() const;
    void setChannelIdNull();

    QString channelName() const;
    void setChannelName(QString newChannelName);
    bool channelNameNull() const;
    void setChannelNameNull();

    std::optional<double> primaryImageAspectRatio() const;
    void setPrimaryImageAspectRatio(std::optional<double> newPrimaryImageAspectRatio);
    bool primaryImageAspectRatioNull() const;
    void setPrimaryImageAspectRatioNull();
 
 
protected:
    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;
 
private:
    // Private constructor which generates an invalid object, for use withing SearchHint::fromJson();
    SearchHint();
};
 
 
} // NS DTO
 
namespace Support {
 
using SearchHint = Jellyfin::DTO::SearchHint;
 
template <>
SearchHint fromJsonValue(const QJsonValue &source, convertType<SearchHint>);
 
template<>
QJsonValue toJsonValue(const SearchHint &source, convertType<SearchHint>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_SEARCHHINT_H