digiKam
Public Types | Signals | Public Member Functions | Static Public Attributes | List of all members
DigikamGenericYFPlugin::YFTalker Class Reference
+ Inheritance diagram for DigikamGenericYFPlugin::YFTalker:

Public Types

enum  State {
  STATE_UNAUTHENTICATED = 0x0 , STATE_AUTHENTICATED = 0x80 , STATE_ERROR = 0x40 , STATE_GETSERVICE = STATE_UNAUTHENTICATED | 0x1 ,
  STATE_GETSERVICE_ERROR = STATE_UNAUTHENTICATED | STATE_ERROR | 0x2 , STATE_GETSERVICE_DONE = STATE_UNAUTHENTICATED | 0x3 , STATE_GETSESSION = STATE_UNAUTHENTICATED | 0x7 , STATE_GETSESSION_ERROR = STATE_UNAUTHENTICATED | STATE_ERROR | 0x8 ,
  STATE_GETSESSION_DONE = STATE_UNAUTHENTICATED | 0x9 , STATE_GETTOKEN = STATE_UNAUTHENTICATED | 0xa , STATE_INVALID_CREDENTIALS = STATE_UNAUTHENTICATED | STATE_ERROR | 0xb , STATE_GETTOKEN_ERROR = STATE_UNAUTHENTICATED | STATE_ERROR | 0xc ,
  STATE_GETTOKEN_DONE = STATE_AUTHENTICATED , STATE_LISTALBUMS = STATE_AUTHENTICATED | 0x1 , STATE_LISTALBUMS_ERROR = STATE_AUTHENTICATED | STATE_ERROR | 0x2 , STATE_LISTALBUMS_DONE = STATE_AUTHENTICATED ,
  STATE_LISTPHOTOS = STATE_AUTHENTICATED | 0x4 , STATE_LISTPHOTOS_ERROR = STATE_AUTHENTICATED | STATE_ERROR | 0x5 , STATE_LISTPHOTOS_DONE = STATE_AUTHENTICATED , STATE_UPDATEPHOTO_FILE = STATE_AUTHENTICATED | 0x7 ,
  STATE_UPDATEPHOTO_FILE_ERROR = STATE_AUTHENTICATED | STATE_ERROR | 0x8 , STATE_UPDATEPHOTO_INFO = STATE_AUTHENTICATED | 0x9 , STATE_UPDATEPHOTO_INFO_ERROR = STATE_AUTHENTICATED | STATE_ERROR | 0xa , STATE_UPDATEPHOTO_DONE = STATE_AUTHENTICATED ,
  STATE_UPDATEALBUM = STATE_AUTHENTICATED | 0xb , STATE_UPDATEALBUM_ERROR = STATE_AUTHENTICATED | STATE_ERROR | 0xc , STATE_UPDATEALBUM_DONE = STATE_AUTHENTICATED
}
 

Signals

void signalError ()
 emits when we are in a bad state More...
 
void signalGetServiceDone ()
 
void signalGetSessionDone ()
 
void signalGetTokenDone ()
 
void signalListAlbumsDone (const QList< YandexFotkiAlbum > &)
 
void signalListPhotosDone (const QList< YFPhoto > &)
 
void signalUpdateAlbumDone ()
 
void signalUpdatePhotoDone (YFPhoto &)
 

Public Member Functions

const QList< YandexFotkiAlbum > & albums () const
 
void cancel ()
 
void getService ()
 
void getSession ()
 
void getToken ()
 
bool isAuthenticated () const
 
bool isErrorState () const
 
void listAlbums ()
 
void listPhotos (const YandexFotkiAlbum &album)
 
const QString & login () const
 
const QString & password () const
 
const QList< YFPhoto > & photos () const
 
void reset ()
 
const QString & sessionId () const
 
const QString & sessionKey () const
 
void setLogin (const QString &login)
 
void setPassword (const QString &password)
 
State state () const
 
const QString & token () const
 
void updateAlbum (YandexFotkiAlbum &album)
 
void updatePhoto (YFPhoto &photo, const YandexFotkiAlbum &album)
 
 YFTalker (QObject *const parent=nullptr)
 
 ~YFTalker () override
 

Static Public Attributes

static const QString USERPAGE_DEFAULT_URL = QLatin1String("https://fotki.yandex.ru/")
 
static const QString USERPAGE_URL = QLatin1String("https://fotki.yandex.ru/users/%1/")
 API-related public constants. More...
 

Member Enumeration Documentation

◆ State

enum DigikamGenericYFPlugin::YFTalker::State
Enumerator
STATE_UNAUTHENTICATED 
STATE_AUTHENTICATED 
STATE_ERROR 
STATE_GETSERVICE 
STATE_GETSERVICE_ERROR 
STATE_GETSERVICE_DONE 
STATE_GETSESSION 
STATE_GETSESSION_ERROR 
STATE_GETSESSION_DONE 
STATE_GETTOKEN 
STATE_INVALID_CREDENTIALS 
STATE_GETTOKEN_ERROR 
STATE_GETTOKEN_DONE 

simple alias

STATE_LISTALBUMS 
STATE_LISTALBUMS_ERROR 
STATE_LISTALBUMS_DONE 
STATE_LISTPHOTOS 
STATE_LISTPHOTOS_ERROR 
STATE_LISTPHOTOS_DONE 
STATE_UPDATEPHOTO_FILE 
STATE_UPDATEPHOTO_FILE_ERROR 
STATE_UPDATEPHOTO_INFO 
STATE_UPDATEPHOTO_INFO_ERROR 
STATE_UPDATEPHOTO_DONE 
STATE_UPDATEALBUM 
STATE_UPDATEALBUM_ERROR 
STATE_UPDATEALBUM_DONE 

Constructor & Destructor Documentation

◆ YFTalker()

DigikamGenericYFPlugin::YFTalker::YFTalker ( QObject *const  parent = nullptr)
explicit

◆ ~YFTalker()

DigikamGenericYFPlugin::YFTalker::~YFTalker ( )
override

References reset().

Member Function Documentation

◆ albums()

const QList< YandexFotkiAlbum > & DigikamGenericYFPlugin::YFTalker::albums ( ) const

◆ cancel()

void DigikamGenericYFPlugin::YFTalker::cancel ( )

References isAuthenticated(), STATE_AUTHENTICATED, and STATE_UNAUTHENTICATED.

◆ getService()

void DigikamGenericYFPlugin::YFTalker::getService ( )

References STATE_GETSERVICE.

◆ getSession()

void DigikamGenericYFPlugin::YFTalker::getSession ( )

References STATE_GETSERVICE_DONE, and STATE_GETSESSION.

◆ getToken()

void DigikamGenericYFPlugin::YFTalker::getToken ( )

References YFAuth::makeCredentials(), STATE_GETSESSION_DONE, and STATE_GETTOKEN.

◆ isAuthenticated()

bool DigikamGenericYFPlugin::YFTalker::isAuthenticated ( ) const

References STATE_AUTHENTICATED.

Referenced by cancel(), listAlbums(), listPhotos(), updateAlbum(), and updatePhoto().

◆ isErrorState()

bool DigikamGenericYFPlugin::YFTalker::isErrorState ( ) const

References STATE_ERROR.

Referenced by listAlbums(), listPhotos(), updateAlbum(), and updatePhoto().

◆ listAlbums()

void DigikamGenericYFPlugin::YFTalker::listAlbums ( )

References isAuthenticated(), and isErrorState().

◆ listPhotos()

void DigikamGenericYFPlugin::YFTalker::listPhotos ( const YandexFotkiAlbum &  album)

References isAuthenticated(), and isErrorState().

◆ login()

const QString & DigikamGenericYFPlugin::YFTalker::login ( ) const

Referenced by setLogin().

◆ password()

const QString & DigikamGenericYFPlugin::YFTalker::password ( ) const

Referenced by setPassword().

◆ photos()

const QList< YFPhoto > & DigikamGenericYFPlugin::YFTalker::photos ( ) const

◆ reset()

void DigikamGenericYFPlugin::YFTalker::reset ( )

References STATE_UNAUTHENTICATED.

Referenced by ~YFTalker().

◆ sessionId()

const QString & DigikamGenericYFPlugin::YFTalker::sessionId ( ) const

◆ sessionKey()

const QString & DigikamGenericYFPlugin::YFTalker::sessionKey ( ) const

◆ setLogin()

void DigikamGenericYFPlugin::YFTalker::setLogin ( const QString &  login)

References login().

◆ setPassword()

void DigikamGenericYFPlugin::YFTalker::setPassword ( const QString &  password)

References password().

◆ signalError

void DigikamGenericYFPlugin::YFTalker::signalError ( )
signal

emits when we are in a bad state

◆ signalGetServiceDone

void DigikamGenericYFPlugin::YFTalker::signalGetServiceDone ( )
signal

◆ signalGetSessionDone

void DigikamGenericYFPlugin::YFTalker::signalGetSessionDone ( )
signal

◆ signalGetTokenDone

void DigikamGenericYFPlugin::YFTalker::signalGetTokenDone ( )
signal

◆ signalListAlbumsDone

void DigikamGenericYFPlugin::YFTalker::signalListAlbumsDone ( const QList< YandexFotkiAlbum > &  )
signal

◆ signalListPhotosDone

void DigikamGenericYFPlugin::YFTalker::signalListPhotosDone ( const QList< YFPhoto > &  )
signal

◆ signalUpdateAlbumDone

void DigikamGenericYFPlugin::YFTalker::signalUpdateAlbumDone ( )
signal

◆ signalUpdatePhotoDone

void DigikamGenericYFPlugin::YFTalker::signalUpdatePhotoDone ( YFPhoto &  )
signal

◆ state()

YFTalker::State DigikamGenericYFPlugin::YFTalker::state ( ) const

◆ token()

const QString & DigikamGenericYFPlugin::YFTalker::token ( ) const

◆ updateAlbum()

void DigikamGenericYFPlugin::YFTalker::updateAlbum ( YandexFotkiAlbum &  album)

References isAuthenticated(), isErrorState(), and DigikamGenericYFPlugin::YandexFotkiAlbum::urn().

◆ updatePhoto()

void DigikamGenericYFPlugin::YFTalker::updatePhoto ( YFPhoto &  photo,
const YandexFotkiAlbum &  album 
)

References isAuthenticated(), isErrorState(), DigikamGenericYFPlugin::YFPhoto::localUrl(), DigikamGenericYFPlugin::YFPhoto::m_apiAlbumUrl, DigikamGenericYFPlugin::YFPhoto::remoteUrl(), DigikamGenericYFPlugin::YFPhoto::setTitle(), and DigikamGenericYFPlugin::YFPhoto::title().

Member Data Documentation

◆ USERPAGE_DEFAULT_URL

const QString DigikamGenericYFPlugin::YFTalker::USERPAGE_DEFAULT_URL = QLatin1String("https://fotki.yandex.ru/")
static

◆ USERPAGE_URL

const QString DigikamGenericYFPlugin::YFTalker::USERPAGE_URL = QLatin1String("https://fotki.yandex.ru/users/%1/")
static

API-related public constants.

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