git.maemo.org Git - situare/blob - src/facebookservice/facebookcredentials.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5        Ville Tiensuu - ville.tiensuu@ixonos.com
   6
   7    Situare is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as published by the Free Software Foundation.
  10
  11    Situare is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Situare; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  19    USA.
  20 */
  21
  22 #ifndef FACEBOOKCREDENTIALS_H
  23 #define FACEBOOKCREDENTIALS_H
  24
  25 #include <QString>
  26
  27 /**
  28 * @brief Class is used to integrate facebook credentials together.
  29 *
  30 * @author Ville Tiensuu
  31 * @class FacebookCredentials facebookcredentials.h "situare/src/facebookservice/facebookcredentials.h"
  32 */
  33 class FacebookCredentials
  34 {
  35 public:
  36     /**
  37     * @brief Default constructor
  38     *
  39     */
  40     FacebookCredentials();
  41
  42     /**
  43     * @brief Set funtion for m_expires member
  44     *
  45     * @param expiresParameter value of parameter is set to m_expires member
  46     */
  47     void setExpires (const QString & expiresParameter);
  48
  49     /**
  50     * @brief Set function for m_sessionKey member
  51     *
  52     * @param sessionKeyParameter value of parameter is set to m_sessionKey member
  53     */
  54     void setSessionKey(const QString & sessionKeyParameter);
  55
  56     /**
  57     * @brief Set function for m_sessionSecret member
  58     *
  59     * @param sessionSecretParameter value of parameter is set to m_sessionSecret member
  60     */
  61     void setSessionSecret(const QString & sessionSecretParameter);
  62
  63     /**
  64     * @brief Set funtion for m_sig member
  65     *
  66     * @param sigParameter value of parameter is set to m_sig member
  67     */
  68     void setSig(const QString & sigParameter);
  69
  70     /**
  71     * @brief Set function for m_userID member
  72     *
  73     * @param userIDParameter value of parameter is set to m_userID member
  74     */
  75     void setUserID(const QString & userIDParameter);
  76
  77     /**
  78     * @brief Get function for m_expires member
  79     *
  80     * @return QString m_expires
  81     */
  82     QString expires() const;
  83
  84     /**
  85     * @brief Get function for m_sessionKey member
  86     *
  87     * @return QString m_sessionKey
  88     */
  89     QString sessionKey() const;
  90
  91     /**
  92     * @brief Get funtion for m_sessionSecret member
  93     *
  94     * @return QString m_sessionSecret
  95     */
  96     QString sessionSecret() const;
  97
  98     /**
  99     * @brief Get function for m_sig member
 100     *
 101     * @return QString m_sig
 102     */
 103     QString sig() const;
 104
 105     /**
 106     * @brief Get function for m_userID member
 107     *
 108     * @return QString m_userID
 109     */
 110     QString userID() const;
 111
 112     /**
 113     * @brief Overloaded operator == is used to compare two FacebookCredentials.
 114     *
 115     * @param credentials to be checked
 116     * @return bool returns true if all members are same, else returns false
 117     */
 118     bool operator==(const FacebookCredentials& credentials);
 119
 120 private:
 121
 122     /**
 123     * @brief String for storing expires
 124     *
 125     * @var m_expires
 126     */
 127     QString m_expires;
 128
 129     /**
 130     * @brief String for storing sessionKey
 131     *
 132     * @var m_sessionKey
 133     */
 134     QString m_sessionKey;
 135
 136     /**
 137     * @brief String for storing sessionSecret
 138     *
 139     * @var m_sessionSecret
 140     */
 141     QString m_sessionSecret;
 142
 143     /**
 144     * @brief String for storing sig
 145     *
 146     * @var m_sig
 147     */
 148     QString m_sig;
 149
 150     /**
 151     * @brief String for storing userID
 152     *
 153     * @var m_userID
 154     */
 155     QString m_userID;
 156 };
 157
 158 #endif // FACEBOOKCREDENTIALS_H