rajcesession.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2011-04-12
 * Description : A tool to export items to Rajce web service
 *
 * Copyright (C) 2011      by Lukas Krejci <krejci.l at centrum dot cz>
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_RAJCE_SESSION_H
#define DIGIKAM_RAJCE_SESSION_H
 
// Qt includes
 
#include <QString>
#include <QVector>
 
// Local includes
 
#include "rajcealbum.h"
 
namespace DigikamGenericRajcePlugin
{
 
enum RajceCommandType
{
    Login = 0,
    Logout,
    ListAlbums,
    CreateAlbum,
    OpenAlbum,
    CloseAlbum,
    AddPhoto
};
 
enum RajceErrorCode
{
    UnknownError = 1,               
    InvalidCommand,                 
    InvalidCredentials,             
    InvalidSessionToken,            
    InvalidOrRepeatedColumnName,    
    InvalidAlbumId,                 
    AlbumDoesntExistOrNoPrivileges, 
    InvalidAlbumToken,              
    AlbumNameEmpty,                 
    FailedToCreateAlbum,            
    AlbumDoesntExist,               
    UnknownApplication,             
    InvalidApplicationKey,          
    FileNotAttached,                
    NewerVersionExists,             
    SavingFileFailed,               
    UnsupportedFileExtension,       
    UnknownClientVersion,           
    NonexistentTarget               
};
 
class RajceSession
{
public:
 
    explicit RajceSession();
    ~RajceSession();
 
    RajceSession(const RajceSession& other);
 
    RajceSession& operator=(const RajceSession& other);
 
public:
 
    QString& sessionToken();
    QString  const& sessionToken()      const;
    QString& nickname();
    QString  const& nickname()          const;
    QString& username();
    QString  const& username()          const;
    QString& openAlbumToken();
    QString  const& openAlbumToken()    const;
    QString& lastErrorMessage();
    QString  const& lastErrorMessage()  const;
 
    unsigned& maxWidth();
    unsigned  maxWidth()                const;
    unsigned& maxHeight();
    unsigned  maxHeight()               const;
    unsigned& imageQuality();
    unsigned  imageQuality()            const;
    unsigned& lastErrorCode();
    unsigned  lastErrorCode()           const;
 
    QVector<RajceAlbum>& albums();
    const QVector<RajceAlbum>& albums() const;
 
    RajceCommandType& lastCommand();
    RajceCommandType  lastCommand()     const;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace DigikamGenericRajcePlugin
 
QDebug operator<<(QDebug d, const DigikamGenericRajcePlugin::RajceSession& s);
 
#endif // DIGIKAM_RAJCE_SESSION_H