Home · All Classes · All Namespaces · Modules · Functions · Files

contact.h

00001 /*
00002  * This file is part of TelepathyQt4
00003  *
00004  * Copyright (C) 2008 Collabora Ltd. <http://www.collabora.co.uk/>
00005  * Copyright (C) 2008 Nokia Corporation
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2.1 of the License, or (at your option) any later version.
00011  *
00012  * This library is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Lesser General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public
00018  * License along with this library; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020  */
00021 
00022 #ifndef _TelepathyQt4_contact_h_HEADER_GUARD_
00023 #define _TelepathyQt4_contact_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <QObject>
00030 #include <QSet>
00031 #include <QSharedPointer>
00032 #include <QVariantMap>
00033 
00034 #include <TelepathyQt4/Types>
00035 
00036 namespace Tp
00037 {
00038 
00039 class ContactManager;
00040 class PendingOperation;
00041 class ReferencedHandles;
00042 
00043 class Contact : public QObject
00044 {
00045     Q_OBJECT
00046     Q_DISABLE_COPY(Contact);
00047 
00048 public:
00049     enum Feature {
00050         FeatureAlias,
00051         FeatureAvatarToken,
00052         FeatureSimplePresence,
00053         _Padding = 0xFFFFFFFF
00054     };
00055 
00056     enum PresenceState {
00057          PresenceStateNo,
00058          PresenceStateAsk,
00059          PresenceStateYes
00060     };
00061 
00062     ContactManager *manager() const;
00063 
00064     ReferencedHandles handle() const;
00065     QString id() const;
00066 
00067     QSet<Feature> requestedFeatures() const;
00068     QSet<Feature> actualFeatures() const;
00069 
00070     QString alias() const;
00071 
00072     bool isAvatarTokenKnown() const;
00073     QString avatarToken() const;
00074 
00075     QString presenceStatus() const;
00076     uint presenceType() const;
00077     QString presenceMessage() const;
00078 
00079     PresenceState subscriptionState() const;
00080     PresenceState publishState() const;
00081 
00082     PendingOperation *requestPresenceSubscription(const QString &message = QString());
00083     PendingOperation *removePresenceSubscription(const QString &message = QString());
00084     PendingOperation *authorizePresencePublication(const QString &message = QString());
00085     PendingOperation *removePresencePublication(const QString &message = QString());
00086 
00087     bool isBlocked() const;
00088     PendingOperation *block(bool value = true);
00089 
00090     QStringList groups() const;
00091     PendingOperation *addToGroup(const QString &group);
00092     PendingOperation *removeFromGroup(const QString &group);
00093 
00094     ~Contact();
00095 
00096 Q_SIGNALS:
00097     void aliasChanged(const QString &alias);
00098     void avatarTokenChanged(const QString &avatarToken);
00099     void simplePresenceChanged(const QString &status, uint type, const QString &presenceMessage);
00100 
00101     void subscriptionStateChanged(Tp::Contact::PresenceState state);
00102     void publishStateChanged(Tp::Contact::PresenceState state);
00103     void blockStatusChanged(bool blocked);
00104 
00105     void addedToGroup(const QString &group);
00106     void removedFromGroup(const QString &group);
00107 
00108     // TODO: consider how the Renaming interface should work and map to Contacts
00109     // I guess it would be something like:
00110     // void renamedTo(Tp::ContactPtr)
00111     // with that contact getting the same features requested as the current one. Or would we rather
00112     // want to signal that change right away with a handle?
00113 
00114 private:
00115     Contact(ContactManager *manager, const ReferencedHandles &handle,
00116             const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00117 
00118     void augment(const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00119 
00120     void receiveAlias(const QString &alias);
00121     void receiveAvatarToken(const QString &avatarToken);
00122     void receiveSimplePresence(const SimplePresence &presence);
00123 
00124     void setSubscriptionState(PresenceState state);
00125     void setPublishState(PresenceState state);
00126     void setBlocked(bool value);
00127 
00128     void setAddedToGroup(const QString &group);
00129     void setRemovedFromGroup(const QString &group);
00130 
00131     struct Private;
00132     friend class ContactManager;
00133     friend struct Private;
00134     Private *mPriv;
00135 };
00136 
00137 typedef QSharedPointer<Contact> ContactPtr;
00138 typedef QSet<ContactPtr> Contacts;
00139 
00140 inline uint qHash(const ContactPtr &contact)
00141 {
00142     return qHash(contact.data());
00143 }
00144 
00145 } // Tp
00146 
00147 #endif


Copyright © 2009 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.1.10