libkfbapi-dev 1.0-0ubuntu7 / usr / include / libkfbapi / notejob.h

/* Copyright 2011 Roeland Jago Douma <unix@rullzer.com>

   This library is free software; you can redistribute it and/or modify
   it under the terms of the GNU Library General Public License as published
   by the Free Software Foundation; either version 2 of the License or
   (at your option) version 3 or, at the discretion of KDE e.V.
   (which shall act as a proxy as in section 14 of the GPLv3), 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KFBAPI_NOTEJOB_H
#define KFBAPI_NOTEJOB_H

#include "facebookjobs.h"
#include "noteinfo.h"

namespace KFbAPI {

class NoteJobPrivate;

/**
* A job to retrieve one or multiple notes from facebook and convert them into
* noteInfo objects.
*/
class LIBKFBAPI_EXPORT NoteJob : public FacebookGetIdJob
{
    Q_OBJECT
public:
    /**
    * @brief Construct a notejob to retrieve multiple notes.
    *
    * @param noteIds A list of ids of notes to retrieve.
    * @param accessToken The token to access data on facebook.
    */
    NoteJob(const QStringList &noteIds, const QString &accessToken, QObject *parent = 0);

    /**
    * @brief Contrust a notejob to retrieve a single note from facebook.
    *
    * @param noteId The id of the note to retrieve.
    * @param accessToken The token to accesss data on facebook.
    */
    NoteJob(const QString &noteId, const QString &accessToken, QObject *parent = 0);

    /**
    * @brief Return a list of all the notes that his job has retrieved
    *
    * @return List of pointers to noteinfo objects
    */
    QList<NoteInfo> noteInfo() const;

private:
    Q_DECLARE_PRIVATE(NoteJob)

    void handleSingleData(const QVariant &data);
};

}

#endif