sessioninfodto.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_SESSIONINFODTO_H
#define JELLYFIN_DTO_SESSIONINFODTO_H
 
#include <QDateTime>
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/dto/baseitemdto.h"
#include "JellyfinQt/dto/clientcapabilitiesdto.h"
#include "JellyfinQt/dto/generalcommandtype.h"
#include "JellyfinQt/dto/mediatype.h"
#include "JellyfinQt/dto/playerstateinfo.h"
#include "JellyfinQt/dto/queueitem.h"
#include "JellyfinQt/dto/sessionuserinfo.h"
#include "JellyfinQt/dto/transcodinginfo.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class SessionInfoDto {
public:
    SessionInfoDto( 
        QSharedPointer<PlayerStateInfo> playState,                  
        QSharedPointer<ClientCapabilitiesDto> capabilities,                 
        QList<MediaType> playableMediaTypes,                    
        QString userId,                         
        QDateTime lastActivityDate,         
        QDateTime lastPlaybackCheckIn,                                  
        QSharedPointer<BaseItemDto> nowPlayingItem,         
        QSharedPointer<BaseItemDto> nowViewingItem,                         
        QSharedPointer<TranscodingInfo> transcodingInfo,            
        bool isActive,          
        bool supportsMediaControl,          
        bool supportsRemoteControl,                         
        bool hasCustomDeviceName,                                   
        QList<GeneralCommandType> supportedCommands     
    );
 
    SessionInfoDto(const SessionInfoDto &other);
    
    void replaceData(SessionInfoDto &other);
    
    static SessionInfoDto fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
 
    QSharedPointer<PlayerStateInfo> playState() const;
 
    void setPlayState(QSharedPointer<PlayerStateInfo> newPlayState);

    QList<SessionUserInfo> additionalUsers() const;
    void setAdditionalUsers(QList<SessionUserInfo> newAdditionalUsers);
    bool additionalUsersNull() const;
    void setAdditionalUsersNull();
 
 
    QSharedPointer<ClientCapabilitiesDto> capabilities() const;
 
    void setCapabilities(QSharedPointer<ClientCapabilitiesDto> newCapabilities);

    QString remoteEndPoint() const;
    void setRemoteEndPoint(QString newRemoteEndPoint);
    bool remoteEndPointNull() const;
    void setRemoteEndPointNull();

    QList<MediaType> playableMediaTypes() const;
    void setPlayableMediaTypes(QList<MediaType> newPlayableMediaTypes);

    QString jellyfinId() const;
    void setJellyfinId(QString newJellyfinId);
    bool jellyfinIdNull() const;
    void setJellyfinIdNull();

    QString userId() const;
    void setUserId(QString newUserId);

    QString userName() const;
    void setUserName(QString newUserName);
    bool userNameNull() const;
    void setUserNameNull();

    QString client() const;
    void setClient(QString newClient);
    bool clientNull() const;
    void setClientNull();

    QDateTime lastActivityDate() const;
    void setLastActivityDate(QDateTime newLastActivityDate);

    QDateTime lastPlaybackCheckIn() const;
    void setLastPlaybackCheckIn(QDateTime newLastPlaybackCheckIn);

    QDateTime lastPausedDate() const;
    void setLastPausedDate(QDateTime newLastPausedDate);
    bool lastPausedDateNull() const;
    void setLastPausedDateNull();

    QString deviceName() const;
    void setDeviceName(QString newDeviceName);
    bool deviceNameNull() const;
    void setDeviceNameNull();

    QString deviceType() const;
    void setDeviceType(QString newDeviceType);
    bool deviceTypeNull() const;
    void setDeviceTypeNull();
 
 
    QSharedPointer<BaseItemDto> nowPlayingItem() const;
 
    void setNowPlayingItem(QSharedPointer<BaseItemDto> newNowPlayingItem);
 
 
    QSharedPointer<BaseItemDto> nowViewingItem() const;
 
    void setNowViewingItem(QSharedPointer<BaseItemDto> newNowViewingItem);

    QString deviceId() const;
    void setDeviceId(QString newDeviceId);
    bool deviceIdNull() const;
    void setDeviceIdNull();

    QString applicationVersion() const;
    void setApplicationVersion(QString newApplicationVersion);
    bool applicationVersionNull() const;
    void setApplicationVersionNull();
 
 
    QSharedPointer<TranscodingInfo> transcodingInfo() const;
 
    void setTranscodingInfo(QSharedPointer<TranscodingInfo> newTranscodingInfo);

    bool isActive() const;
    void setIsActive(bool newIsActive);

    bool supportsMediaControl() const;
    void setSupportsMediaControl(bool newSupportsMediaControl);

    bool supportsRemoteControl() const;
    void setSupportsRemoteControl(bool newSupportsRemoteControl);

    QList<QueueItem> nowPlayingQueue() const;
    void setNowPlayingQueue(QList<QueueItem> newNowPlayingQueue);
    bool nowPlayingQueueNull() const;
    void setNowPlayingQueueNull();

    QList<BaseItemDto> nowPlayingQueueFullItems() const;
    void setNowPlayingQueueFullItems(QList<BaseItemDto> newNowPlayingQueueFullItems);
    bool nowPlayingQueueFullItemsNull() const;
    void setNowPlayingQueueFullItemsNull();

    bool hasCustomDeviceName() const;
    void setHasCustomDeviceName(bool newHasCustomDeviceName);

    QString playlistItemId() const;
    void setPlaylistItemId(QString newPlaylistItemId);
    bool playlistItemIdNull() const;
    void setPlaylistItemIdNull();

    QString serverId() const;
    void setServerId(QString newServerId);
    bool serverIdNull() const;
    void setServerIdNull();

    QString userPrimaryImageTag() const;
    void setUserPrimaryImageTag(QString newUserPrimaryImageTag);
    bool userPrimaryImageTagNull() const;
    void setUserPrimaryImageTagNull();

    QList<GeneralCommandType> supportedCommands() const;
    void setSupportedCommands(QList<GeneralCommandType> newSupportedCommands);
 
 
protected:
    QSharedPointer<PlayerStateInfo> m_playState = QSharedPointer<PlayerStateInfo>();
    QList<SessionUserInfo> m_additionalUsers;
    QSharedPointer<ClientCapabilitiesDto> m_capabilities = QSharedPointer<ClientCapabilitiesDto>();
    QString m_remoteEndPoint;
    QList<MediaType> m_playableMediaTypes;
    QString m_jellyfinId;
    QString m_userId;
    QString m_userName;
    QString m_client;
    QDateTime m_lastActivityDate;
    QDateTime m_lastPlaybackCheckIn;
    QDateTime m_lastPausedDate;
    QString m_deviceName;
    QString m_deviceType;
    QSharedPointer<BaseItemDto> m_nowPlayingItem = QSharedPointer<BaseItemDto>();
    QSharedPointer<BaseItemDto> m_nowViewingItem = QSharedPointer<BaseItemDto>();
    QString m_deviceId;
    QString m_applicationVersion;
    QSharedPointer<TranscodingInfo> m_transcodingInfo = QSharedPointer<TranscodingInfo>();
    bool m_isActive;
    bool m_supportsMediaControl;
    bool m_supportsRemoteControl;
    QList<QueueItem> m_nowPlayingQueue;
    QList<BaseItemDto> m_nowPlayingQueueFullItems;
    bool m_hasCustomDeviceName;
    QString m_playlistItemId;
    QString m_serverId;
    QString m_userPrimaryImageTag;
    QList<GeneralCommandType> m_supportedCommands;
 
private:
    // Private constructor which generates an invalid object, for use withing SessionInfoDto::fromJson();
    SessionInfoDto();
};
 
 
} // NS DTO
 
namespace Support {
 
using SessionInfoDto = Jellyfin::DTO::SessionInfoDto;
 
template <>
SessionInfoDto fromJsonValue(const QJsonValue &source, convertType<SessionInfoDto>);
 
template<>
QJsonValue toJsonValue(const SessionInfoDto &source, convertType<SessionInfoDto>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_SESSIONINFODTO_H